autopatrol, editnews
151
edits
Help:Tools/BCML: Difference between revisions
Partial rewrite for bcml3
imported>Ginger (→Setup: Added VC++ Redist requirement) |
(Partial rewrite for bcml3) |
||
| Line 9: | Line 9: | ||
}} | }} | ||
BCML ('''B'''reath of the Wild '''C''' | BCML ('''B'''reath of the Wild '''C'''ross-platform '''M'''od '''L'''oader) is a mod installer and merging tool for BotW 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== | ||
| Line 25: | Line 25: | ||
==Usage== | ==Usage== | ||
[[File:BCML GUI Preview.png|thumb|right|BCML GUI Interface]] | [[File:BCML GUI Preview.png|thumb|right|BCML GUI Interface - Old version 1.0]] | ||
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. | ||
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: | ||
*''' | *'''+''' (in the bottom right): Installs a mod. Note that BCML only supports graphic pack mods in ZIP, RAR, or 7z format, or BNP ('''B'''CML '''N'''ano '''P'''atch) format files. | ||
*''' | *'''Hamburger button''' (bottom left): Show sort handles, 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): Manually triggers a fresh merge of the RSTB, packs, and texts. Deletes old merged files and completely remakes them anew. | ||
*'''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. | ||
| Line 38: | Line 38: | ||
==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. | ||