Help:Tools/BCML: Difference between revisions
Jump to navigation
Jump to search
imported>NiceneNerd m (Added GUI screenshot) |
imported>Ginger (→Setup: Added VC++ Redist requirement) |
||
| Line 11: | Line 11: | ||
BCML ('''B'''reath of the Wild '''C'''emu '''M'''od '''L'''oader) is a mod installer and merging tool for BotW graphic pack mods. It can be used to install and uninstall mods by priority and merge conflicts in the [[ResourceSizeTable.product.rsizetable|RSTB]], [[SARC]] (pack) files, or [[Message_archives|game texts]]. | BCML ('''B'''reath of the Wild '''C'''emu '''M'''od '''L'''oader) is a mod installer and merging tool for BotW graphic pack mods. It can be used to install and uninstall mods by priority and merge conflicts in the [[ResourceSizeTable.product.rsizetable|RSTB]], [[SARC]] (pack) files, or [[Message_archives|game texts]]. | ||
== Setup == | ==Setup== | ||
There are two primary ways to install BCML. | There are two primary ways to install BCML. Both options also require you to install the Microsoft Visual C++ Redistributable located [https://aka.ms/vs/16/release/vc_redist.x64.exe here]. | ||
'''Option 1''' | '''Option 1''' | ||
# Download the latest BCML setup executable from [https://gamebanana.com/tools/6624 GameBanana]. | |||
# Run the setup and install BCML. | #Download the latest BCML setup executable from [https://gamebanana.com/tools/6624 GameBanana]. | ||
#Run the setup and install BCML. | |||
'''Option 2''' | '''Option 2''' | ||
== Usage == | #Ensure you have a '''64 bit version''' of Python 3.7+ installed and added to your PATH. | ||
#Install the <code>bcml</code> pip package. {{Install py package help|package=bcml}} | |||
==Usage== | |||
[[File:BCML GUI Preview.png|thumb|right|BCML GUI Interface]] | [[File:BCML GUI Preview.png|thumb|right|BCML GUI Interface]] | ||
If installed by the setup executable, BCML can be launched from the Start Menu or desktop shortcut(s). If installed using <code>pip</code>, BCML can be launched with the <code>bcml</code> command for the CLI version or the <code>bcml-gui</code> command for the graphical version. {{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory. | If installed by the setup executable, BCML can be launched from the Start Menu or desktop shortcut(s). If installed using <code>pip</code>, BCML can be launched with the <code>bcml</code> command for the CLI version or the <code>bcml-gui</code> command for the graphical version. {{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory. | ||
| Line 27: | Line 30: | ||
The commands between the CLI and GUI version are the same, for more information about them, consult the [https://github.com/NiceneNerd/BCML/blob/master/docs/README.md readme on GitHub]. A basic overview: | The commands between the CLI and GUI version are the same, for more information about them, consult the [https://github.com/NiceneNerd/BCML/blob/master/docs/README.md readme on GitHub]. A basic overview: | ||
* '''Install/Uninstall''': Installs or uninstalls a mod. Note that BCML only supports graphic pack mods in ZIP, RAR, or 7z format. | *'''Install/Uninstall''': Installs or uninstalls a mod. Note that BCML only supports graphic pack mods in ZIP, RAR, or 7z format. | ||
* '''Change Priority''': Changes the load priority of a mod and then adjusts any RSTB, pack, or text merges as needed. | *'''Change Priority''': Changes the load priority of a mod and then adjusts any RSTB, pack, or text merges as needed. | ||
* '''Update''': Manually triggers a fresh merge of the RSTB, packs, and texts. | *'''Update''': Manually triggers a fresh merge of the RSTB, packs, and texts. | ||
* '''Export''': Exports all installed mods as a single mod. Can export using different folder structures for use as a graphic pack, an SDCaffiine mod, or mlc file replacement. | *'''Export''': Exports all installed mods as a single mod. Can export using different folder structures for use as a graphic pack, an SDCaffiine mod, or mlc file replacement. | ||
* '''Explore''': GUI only, opens the folder where the selected mod is installed. | *'''Explore''': GUI only, opens the folder where the selected mod is installed. | ||
== Known Issues == | ==Known Issues== | ||
* There is currently no option to change the path to your Cemu directory where the modded graphic packs will be installed. If you need to change this, edit or delete the file <code>%LOCALAPPDATA%\bcml\.cdir</code>. | *There is currently no option to change the path to your Cemu directory where the modded graphic packs will be installed. If you need to change this, edit or delete the file <code>%LOCALAPPDATA%\bcml\.cdir</code>. | ||
* Only the US English game is fully supported. Some mods installed through BCML may crash other versions, especially mods that change game texts. | *Only the US English game is fully supported. Some mods installed through BCML may crash other versions, especially mods that change game texts. | ||
Revision as of 17:00, 28 April 2020
| Author(s) | Nicene Nerd |
|---|---|
| Source code | https://github.com/NiceneNerd/BCML |
| License | GLPv3+ |
| Written in | Python |
| Platform support | 👎 Windows only |
BCML (Breath of the Wild Cemu Mod Loader) is a mod installer and merging tool for BotW graphic pack mods. It can be used to install and uninstall mods by priority and merge conflicts in the RSTB, SARC (pack) files, or game texts.
Setup
There are two primary ways to install BCML. Both options also require you to install the Microsoft Visual C++ Redistributable located here.
Option 1
- Download the latest BCML setup executable from GameBanana.
- Run the setup and install BCML.
Option 2
- Ensure you have a 64 bit version of Python 3.7+ installed and added to your PATH.
- Install the
bcmlpip package. [CLI help]
Usage
If installed by the setup executable, BCML can be launched from the Start Menu or desktop shortcut(s). If installed using pip, BCML can be launched with the bcml command for the CLI version or the bcml-gui command for the graphical version. [help] A desktop shortcut can also be made pointing to the executable in Python's Scripts directory.
The commands between the CLI and GUI version are the same, for more information about them, consult the readme on GitHub. A basic overview:
- Install/Uninstall: Installs or uninstalls a mod. Note that BCML only supports graphic pack mods in ZIP, RAR, or 7z format.
- Change Priority: Changes the load priority of a mod and then adjusts any RSTB, pack, or text merges as needed.
- Update: Manually triggers a fresh merge of the RSTB, packs, and texts.
- Export: Exports all installed mods as a single mod. Can export using different folder structures for use as a graphic pack, an SDCaffiine mod, or mlc file replacement.
- Explore: GUI only, opens the folder where the selected mod is installed.
Known Issues
- There is currently no option to change the path to your Cemu directory where the modded graphic packs will be installed. If you need to change this, edit or delete the file
%LOCALAPPDATA%\bcml\.cdir. - Only the US English game is fully supported. Some mods installed through BCML may crash other versions, especially mods that change game texts.