Help:Tools/BCML - Revision history

Nebroc: added a "known issue" with cemu 2.1 AppData stuff

2024-10-18T20:52:37Z

added a "known issue" with cemu 2.1 AppData stuff

← Older revision		Revision as of 20:52, 18 October 2024
Line 48:		Line 48:

	*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.
			*Cemu 2.1+ isn't supported since Cemu moved most of it data to AppData rather than next of the exe, you can [https://wiki.cemu.info/wiki/Release_1.26.2f use Cemu 1.26.2f], follow [https://discord.com/channels/316759222207643649/606813647674540032/1278361320160235581 this workaround] or simply [https://nicenenerd.github.io/UKMM use UKMM].

	==Merge All the Mods: Getting Started with BCML 3 Instructional Video==		==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]		[https://www.youtube.com/watch?v=8gKRifYyA68 Merge All the Mods: Getting Started with BCML 3 Instructional Video on YouTube]

Ginger: /* Linux Extra Setup */ Explicitly specify that these are Steam Deck instructions as well

2024-06-27T16:16:35Z

Linux Extra Setup: Explicitly specify that these are Steam Deck instructions as well

← Older revision		Revision as of 16:16, 27 June 2024
Line 25:		Line 25:

	===Linux Extra Setup===		===Linux Extra Setup===
	BCML only has partial support for Linux, so some extra steps are needed to make it work for Linux.		BCML only has partial support for Linux, so some extra steps are needed to make it work for Linux. (This includes Steam Deck)

	First, check the BCML setting to use without a Cemu installation, even if you are using it with Cemu. If Cemu is installed on a different drive than BCML is (e.g. flash drive) then also check the setting to disable links for the master mod.		First, check the BCML setting to use without a Cemu installation, even if you are using it with Cemu. If Cemu is installed on a different drive than BCML is (e.g. flash drive) then also check the setting to disable links for the master mod.

Ginger: /* Setup */ Extra Linux setup steps

2024-06-27T16:14:30Z

Setup: Extra Linux setup steps

← Older revision		Revision as of 16:14, 27 June 2024
Line 23:		Line 23:

	If you would like to have a shortcut made, BCML has that option on the settings page.		If you would like to have a shortcut made, BCML has that option on the settings page.

			===Linux Extra Setup===
			BCML only has partial support for Linux, so some extra steps are needed to make it work for Linux.

			First, check the BCML setting to use without a Cemu installation, even if you are using it with Cemu. If Cemu is installed on a different drive than BCML is (e.g. flash drive) then also check the setting to disable links for the master mod.

			Second, set the merged export directory to the path that Cemu will read the BCML graphic pack from. Depending on your distro and the app binary you use, this can be different places, so you may need to find the location, yourself. Two examples would be <code>~/.config/cemu/BreathOfTheWild_BCML</code> or <code>~/.local/share/cemu/BreathOfTheWild_BCML</code>. (Note that ~ is Linux shorthand for <code>/home/<username></code> for all non-root accounts)
			* Do NOT set the merged export directory to the base graphic pack folder! E.g. <code>~/.config/cemu</code>. Do NOT. If you do, BCML will delete things it shouldn't whenever you install or uninstall a mod.

			Last, install your first mod with BCML. Once it is installed, go to the merged export directory in your file viewer and add a file called <code>rules.txt</code> based on the format described on [[Help:Using_mods#Installing_mods_with_the_graphic_pack_menu\|this page]].

	==Usage==		==Usage==

HGStone: updated link for visual c++

2024-01-21T21:00:55Z

updated link for visual c++

← Older revision		Revision as of 21:00, 21 January 2024
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).		Open a command prompt anywhere (if you don't know how, just type <code>cmd</code> into Windows Search).

HGStone at 16:17, 20 January 2024

2024-01-20T16:17:42Z

← Older revision		Revision as of 16:17, 20 January 2024
Line 14:		Line 14:
	Open a command prompt anywhere (if you don't know how, just type <code>cmd</code> into Windows Search).		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.		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.

			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.		To run BCML all you need to do is type <code>bcml</code> into a cmd prompt.

HGStone: removed the obsolete special instructions for switch users

2022-11-06T13:49:37Z

removed the obsolete special instructions for switch users

← Older revision		Revision as of 13:49, 6 November 2022
Line 13:		Line 13:

	Open a command prompt anywhere (if you don't know how, just type <code>cmd</code> into Windows Search).		Open a command prompt anywhere (if you don't know how, just type <code>cmd</code> into Windows Search).
	*'''WiiU/Cemu users''': 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.
	*'''Switch/Yuzu users''': Run <code>pip install bcml~~==3.9.24~~</code> (in normal cmd, NOT the python console). You should see a bunch of progress bars, and then a success message~~. Do not update BCML if prompted~~.		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.

	To run BCML all you need to do is type <code>bcml</code> into a cmd prompt.		To run BCML all you need to do is type <code>bcml</code> into a cmd prompt.

HGStone: added specific instructions for switch users needing version 3.9.24.. changed instructions for creating shortcuts as BCML now can make them. added a link to Nicene's instructional video at the end.

2022-10-15T23:06:38Z

added specific instructions for switch users needing version 3.9.24.. changed instructions for creating shortcuts as BCML now can make them. added a link to Nicene's instructional video at the end.

← Older revision		Revision as of 23:06, 15 October 2022
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://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.		Open a command prompt anywhere (if you don't know how, just type <code>cmd</code> into Windows Search).
			*'''WiiU/Cemu users''': 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.
			*'''Switch/Yuzu users''': Run <code>pip install bcml==3.9.24</code> (in normal cmd, NOT the python console). You should see a bunch of progress bars, and then a success message. Do not update BCML if prompted.

	If you~~'d like~~ to ~~make a shortcut for BCML, search~~ <code>~~pythonw.exe</code> in Windows search, and hit <code>Open file location~~</code>. ~~Right click the exe and create~~ a shortcut, ~~then go into its properties. Add <code> -m bcml</code> to the end of the text in~~ the ~~top box, then pin the shortcut to your taskbar~~.		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==
Line 30:		Line 34:

	*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]

HGStone: /* Usage */

2022-07-10T15:00:42Z

Usage

← Older revision		Revision as of 15:00, 10 July 2022
Line 18:		Line 18:
	==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, in which case you select the <code>rules.txt</code> or <code>info.json</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.

HGStone: /* Usage */

2022-07-10T15:00:18Z

Usage

← Older revision		Revision as of 15:00, 10 July 2022
Line 18:		Line 18:
	==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> or <code>info.json</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.

HGStone: /* Usage */

2022-07-10T14:59:12Z

Usage

← Older revision		Revision as of 14:59, 10 July 2022
Line 18:		Line 18:
	==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 for Wii U/Cemu mods only, 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.