Help:Tools/BCML: Difference between revisions

Jump to navigation Jump to search
m
updated link for visual c++
mNo edit summary
m (updated link for visual c++)
 
(7 intermediate revisions by 2 users not shown)
Line 10: Line 10:


==Setup==
==Setup==
-BCML requires Python [https://www.python.org/ftp/python/3.8.10/python-3.8.10-amd64.exe 3.8.10] or [https://www.python.org/ftp/python/3.7.9/python-3.7.9-amd64.exe 3.7.9], and the [https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads#section-2 x64 Visual C++ redistributable]. When you open the Python installer, there will be a checkbox that says <code>Add Python to PATH</code>. You MUST check this box, or else BCML can't be installed. From here, continue as normal, and install the x64 Visual C++ redistributable.
BCML requires Python [https://www.python.org/ftp/python/3.8.10/python-3.8.10-amd64.exe 3.8.10] or [https://www.python.org/ftp/python/3.7.9/python-3.7.9-amd64.exe 3.7.9], and the [https://aka.ms/vs/17/release/vc_redist.x64.exe x64 Visual C++ redistributable]. When you open the Python installer, there will be a checkbox that says <code>Add Python to PATH</code>. You MUST check this box, or else BCML can't be installed. From here, continue as normal, and install the x64 Visual C++ redistributable.


Open a command prompt anywhere (if you don't know how, just type <code>cmd</code> into Windows Search). Run <code>pip install bcml</code> (in normal cmd, NOT the python console). You should see a bunch of progress bars, and then a success message.
Open a command prompt anywhere (if you don't know how, just type <code>cmd</code> into Windows Search).  


If you'd like to make a shortcut for BCML, search <code>bcml</code> in Windows search, then right click and hit <code>Open file location</code>. Right click <code>bcml.exe</code> and hit <code>Create Shortcut</code>. Move that shortcut anywhere you'd like.
Most people will want to use BCML version 3.10.4 in order to support more mods. BCML version 3.10.5 and up removed support for older BCML V2 mods in order to allow newer python versions.


If you'd like to have BCML on the taskbar, simply drag <code>bcml.exe</code> to the taskbar.
To install BCML 3.10.4 open a cmd prompt and run <code>pip install bcml==3.10.4</code> (to install latest bcml type <code>pip install bcml</code>)
 
You should see a bunch of progress bars, and then a success message.
 
To run BCML all you need to do is type <code>bcml</code> into a cmd prompt.
 
If you would like to have a shortcut made, BCML has that option on the settings page.


==Usage==
==Usage==
[[File:BCML-3.png|thumb|right|BCML 3.4.9's UI]]
[[File:BCML-3.png|thumb|right|BCML 3.4.9's UI]]
*'''+''' (in the bottom right): Installs a mod. Note that BCML supports mods in ZIP, RAR, 7z, or BNP formats. It also supports loose file format for Wii U/Cemu mods only, in which case you select the <code>rules.txt</code> to install.
*'''+''' (in the bottom right): Installs a mod. Note that BCML supports mods in ZIP, RAR, 7z, or BNP formats. It also supports loose file format, in which case you select the <code>rules.txt</code> or <code>info.json</code> to install.
*'''Hamburger button (bottom left)''': Show sort handles in the mod list, to drag and drop, which changes mod load order. Changes the load priority of a mod and then adjusts any RSTB, pack, or text merges as needed.
*'''Hamburger button (bottom left)''': Show sort handles in the mod list, to drag and drop, which changes mod load order. Changes the load priority of a mod and then adjusts any RSTB, pack, or text merges as needed.
*'''Circular Arrow (bottom left)''': Remakes all merged mod files. Use this as a first option when you run into mod conflicts.
*'''Circular Arrow (bottom left)''': Remakes all merged mod files. Use this as a first option when you run into mod conflicts.
Line 32: Line 38:


*Certain game files are too complex for the basic merging logic, and custom logic will have to be written for them. Almost all mods made as of Oct 17, 2020 are currently supported, but future mods may not be.
*Certain game files are too complex for the basic merging logic, and custom logic will have to be written for them. Almost all mods made as of Oct 17, 2020 are currently supported, but future mods may not be.
==Merge All the Mods: Getting Started with BCML 3 Instructional Video==
[https://www.youtube.com/watch?v=8gKRifYyA68 Merge All the Mods: Getting Started with BCML 3 Instructional Video on YouTube]
15

edits

Navigation menu