Help:Tools/BCML: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Simplify shortcut/taskbar creation, reorganize usage section) |
||
| Line 10: | Line 10: | ||
==Setup== | ==Setup== | ||
-BCML requires Python | -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. | ||
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. | |||
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. | |||
If you'd like to have BCML on the taskbar, right-click on the BCML taskbar icon when BCML is open and select <code>Pin to taskbar</code>. | |||
==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. | |||
*'''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. | |||
*'''+''' (in the bottom right): Installs a mod. Note that BCML | |||
*'''Hamburger button | |||
*'''Circular Arrow | |||
*'''Export''': Exports all installed mods as a single mod. The exported zip file will be in a graphics pack format, or Atmosphere format (if in Switch mode) | *'''Export''': Exports all installed mods as a single mod. The exported zip file will be in a graphics pack format, or Atmosphere format (if in Switch mode) | ||
*'''Explore''': Opens the folder where the selected mod is installed. | *'''Explore''': Opens the folder where the selected mod is installed. | ||
*'''Hamburger button (top right)''': Dropdown menu that includes the BCML in-app help. Refer to this menu, first, if you have any issues. | |||
If the in-app help does not solve your issue, try consulting the [https://github.com/NiceneNerd/BCML/wiki/Troubleshooting BCML troubleshooting] page. It's a bit out of date, but it has some useful information. | |||
==Known Issues== | ==Known Issues== | ||
*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. | ||
Revision as of 21:30, 21 July 2021
| Author(s) | Nicene Nerd |
|---|---|
| Source code | https://github.com/NiceneNerd/BCML |
| License | GLPv3+ |
| Written in | Python |
| Platform support | Cross-platform |
BCML (Breath of the Wild Cross-platform Mod Loader) is the mod manager for BotW. It is used to install and uninstall mods, and solves many mod conflicts.
Setup
-BCML requires Python 3.8.10 or 3.7.9, and the x64 Visual C++ redistributable. When you open the Python installer, there will be a checkbox that says Add Python to PATH. 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 cmd into Windows Search). Run pip install bcml (in normal cmd, NOT the python console). You should see a bunch of progress bars, and then a success message.
If you'd like to make a shortcut for BCML, search bcml in Windows search, then right click and hit Open file location. Right click bcml.exe and hit Create Shortcut. Move that shortcut anywhere you'd like.
If you'd like to have BCML on the taskbar, right-click on the BCML taskbar icon when BCML is open and select Pin to taskbar.
Usage
- + (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
rules.txtto 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.
- Circular Arrow (bottom left): Remakes all merged mod files. Use this as a first option when you run into mod conflicts.
- Export: Exports all installed mods as a single mod. The exported zip file will be in a graphics pack format, or Atmosphere format (if in Switch mode)
- Explore: Opens the folder where the selected mod is installed.
- Hamburger button (top right): Dropdown menu that includes the BCML in-app help. Refer to this menu, first, if you have any issues.
If the in-app help does not solve your issue, try consulting the BCML troubleshooting page. It's a bit out of date, but it has some useful information.
Known Issues
- 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.