Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

BrawlBuilder Wii: Difference between revisions

From GameBrew
(Created page with "{{#seo: |title=Wii Rom Hacks (Hack Utilities) - GameBrew |title_mode=append |image=brawlbuilderwii.png |image_alt=BrawlBuilder }} {{Infobox Wii Homebrews |title=BrawlBuilder |image=brawlbuilderwii.png |description=The Ultimate Super Smash Bros Brawl ISO Builder. |author=mogzol |lastupdated=2016/09/27 |type=Hack Utilities |version=1.2.3 |license=MIT |download=https://dlhb.gamebrew.org/wiihomebrews/brawlbuilderwii.7z |website=http://smashboards.com/threads/432675 |source=h...")
 
No edit summary
Line 1: Line 1:
{{#seo:
|title=Wii Rom Hacks (Hack Utilities) - GameBrew
|title_mode=append
|image=brawlbuilderwii.png
|image_alt=BrawlBuilder
}}
{{Infobox Wii Homebrews
{{Infobox Wii Homebrews
|title=BrawlBuilder
|title=BrawlBuilder
|image=brawlbuilderwii.png
|image=brawlbuilderwii2.png
|description=The Ultimate Super Smash Bros Brawl ISO Builder.
|description=The Ultimate Super Smash Bros Brawl ISO Builder.
|author=mogzol
|author=mogzol
Line 18: Line 12:
|source=https://github.com/mogzol/BrawlBuilder
|source=https://github.com/mogzol/BrawlBuilder
}}
}}
'''BrawlBuilder''' is a tool for creating modified SSBB ISOs. It supports many Brawl mods, but there may be some problems. Project M versions 3.6 and above work well, including support for sfx .sawnd files and alternate stages.
BrawlBuilder is a tool to build modded SSBB ISOs. It supports many Brawl mods, but there may be some problems. Project M versions 3.6 and above work well, including support for sfx .sawnd files and alternate stages.


Most Project M mods should also work, but Legacy M is not currently supported. Compatibility with other Brawl mods is uncertain, but anything using BrawlEx will not work beyond version 2.x.6. It is hoped that compatibility will improve in the future. For discussion or issues with BrawlBuilder, visit the official thread on [http://smashboards.com/threads/432675 Smashboards].  
Most Project M mods should also work, but Legacy M is not currently supported. Compatibility with other Brawl mods is uncertain, but anything using BrawlEx will not work beyond version 2.x.6. It is hoped that compatibility will improve in the future. For discussion or issues with BrawlBuilder, visit the official thread on [http://smashboards.com/threads/432675 Smashboards].  


==Command line arguments==
==User guide==
* '''--show-wit''' - This will show the wit command line windows rather than hiding them and displaying the progress in the UI.
Command line arguments:
* '''--show-wit-debug''' - This will do the same thing as --show-wit, but it will keep the wit windows open once wit closes, allowing you to read the output and figure out what is going wrong.
* <code>--show-wit</code> - This will show the wit command line windows rather than hiding them and displaying the progress in the UI.
* '''--no-gct-patch''' - This will disable patching of the GCT based on the CodePatches.txt file in the Resources folder. Use of this option is not recommended.
* <code>--show-wit-debug</code> - This will do the same thing as <code>--show-wit</code>, but it will keep the wit windows open once wit closes, allowing you to read the output and figure out what is going wrong.
* '''--notify-gct-patch''' - This will notify you of how many GCT patches were applied from the CodePatches.txt file.
* <code>--no-gct-patch</code> - This will disable patching of the GCT based on the CodePatches.txt file in the Resources folder. Use of this option is not recommended.
* '''--no-alt-pad''' - This will disable alternate stage padding. Alternate stages are padded to the size of their largest alt. Disabling this will cause any alternate stage that has a file size greater than its non-alt version to stop working.
* <code>--notify-gct-patch</code> - This will notify you of how many GCT patches were applied from the CodePatches.txt file.
* '''--offset=X''' - This will change the offset that the GCT is applied at (by default 80570000) to whatever X is. Setting this to 80568000 will allow Legacy M to progress a bit further than it normally does before crashing. If your mod isn't working check its gameconfig.txt for the codeliststart line, and try using the offset listed there. Note that Resources/patch/PatchCommon.xml also patches some stuff to 8057 and 0000, I don't know if thats related, but you could try editing that to match your codeliststart as well and see if it helps.
* <code>--no-alt-pad</code> - This will disable alternate stage padding. Alternate stages are padded to the size of their largest alt. Disabling this will cause any alternate stage that has a file size greater than its non-alt version to stop working.
* <code>--offset=X</code> - This will change the offset that the GCT is applied at (by default 80570000) to whatever X is. Setting this to 80568000 will allow Legacy M to progress a bit further than it normally does before crashing. If your mod isn't working check its gameconfig.txt for the codeliststart line, and try using the offset listed there. Note that Resources/patch/PatchCommon.xml also patches some stuff to 8057 and 0000, don't know if that's related, but you could try editing that to match your codeliststart as well and see if it helps.


==Media==
===Notes===
'''How to make a Project M ISO. - ([https://www.youtube.com/watch?v=myOYKUdz35I FancySC])'''<br>
BrawlBuilder attempts to patch any GCT files you give to it in order to fix numerous problems caused by loading files from disc instead of SD. The original GCT won't be modified, patches are applied to a temporary copy of it. GCT files are patched based on the CodePatches.txt file in the Resources folder. That file currently contains patches allowing for alternate stage compatibility, replacement soundbank engine compatibility, and P:M 3.6 support in general. Feel free to modify the CodePatches file with your own patches, there is a brief description of how to use it in the comments at the top of the file.
<youtube>myOYKUdz35I</youtube>


==Screenshot==
If you are experiencing issues when playing the output ISO, make sure that you either don't have an SD card inserted, or your SD card doesn't have any mod files on it, as most mods (depending on the GCT patches that get applied) will still try to load from SD before loading from disc. In Dolphin, to eject the SD card just go in to the 'Config' menu, then go to the 'Wii' tab and untick 'Insert SD Card'.
https://dlhb.gamebrew.org/wiihomebrews/brawlbuilderwii-01.png


==Notes==
If you are building this from source, make sure the Resources folder from the base directory is getting copied into the same directory as the exe file, or else nothing will work. This should happen automatically on build, but if it doesn't, just copy it manually.
*BrawlBuilder attempts to patch any GCT files you give to it in order to fix numerous problems caused by loading files from disc instead of SD. The original GCT won't be modified, patches are applied to a temporary copy of it. GCT files are patched based on the CodePatches.txt file in the Resources folder. That file currently contains patches allowing for alternate stage compatibility, replacement soundbank engine compatibility, and P:M 3.6 support in general. Feel free to modify the CodePatches file with your own patches, there is a brief description of how to use it in the comments at the top of the file.


*If you are experiencing issues when playing the output ISO, make sure that you either don't have an SD card inserted, or your SD card doesn't have any mod files on it, as most mods (depending on the GCT patches that get applied) will still try to load from SD before loading from disc. In Dolphin, to eject the SD card just go in to the 'Config' menu, then go to the 'Wii' tab and untick 'Insert SD Card'.
==Screenshots==
brawlbuilderwii3.png


*If you are building this from source, make sure the Resources folder from the base directory is getting copied into the same directory as the exe file, or else nothing will work. This should happen automatically on build, but if it doesn't, just copy it manually.
==Media==
'''How to make a Project M ISO. ([https://www.youtube.com/watch?v=myOYKUdz35I FancySC])'''<br>
<youtube>myOYKUdz35I</youtube>


==Changelog==
==Changelog==
Line 48: Line 43:
*The necessary parts of Ookii.Dialogs (i.e., the folder select dialog) are now compiled into the BrawlBuilder executable, which means the external DLL is no longer required. This should fix the issues some people are having with their computer blocking the DLL.
*The necessary parts of Ookii.Dialogs (i.e., the folder select dialog) are now compiled into the BrawlBuilder executable, which means the external DLL is no longer required. This should fix the issues some people are having with their computer blocking the DLL.
'''v1.2.2'''
'''v1.2.2'''
*Fix custom working directories not working (again)
*Fix custom working directories not working (again).
'''v1.2.1'''
'''v1.2.1'''
*Remove the BrawlBuilder.exe.config file
*Remove the BrawlBuilder.exe.config file.
*Fix 'Custom banner' browse button appearance for certain Windows versions/themes
*Fix 'Custom banner' browse button appearance for certain Windows versions/themes.
'''v1.2'''
'''v1.2'''
* Fix some stages glitching/crashing due to improper .rel files
* Fix some stages glitching/crashing due to improper .rel files.
'''v1.1.2'''
'''v1.1.2'''
*Fix BrawlBuilder not working with custom working directories
*Fix BrawlBuilder not working with custom working directories.
'''v1.1.1'''
'''v1.1.1'''
*Hopefully this will fix the 'wit exited with error code -1' error some people are receiving. I haven't been able to produce the error myself, so I can only guess at what is causing it.
*Hopefully this will fix the 'wit exited with error code -1' error some people are receiving. I haven't been able to produce the error myself, so I can only guess at what is causing it.
*Add 'Finalizing...' status at end of build so it doesn't seem like build is frozen at 99%.
*Add 'Finalizing...' status at end of build so it doesn't seem like build is frozen at 99%.
'''v1.1'''
'''v1.1'''
* Improve error messages, most of them should now actually be somewhat helpful
* Improve error messages, most of them should now actually be somewhat helpful.
* Fix "Build Completed" sometimes appearing even if the build did not complete properly
* Fix "Build Completed" sometimes appearing even if the build did not complete properly.
* Add the --show-wit-debug option to show wit windows and keep them open after wit closes
* Add the --show-wit-debug option to show wit windows and keep them open after wit closes.
* Modify the help text for the Brawl ISO to clarify how the ssbb.d folder works
* Modify the help text for the Brawl ISO to clarify how the ssbb.d folder works.
* Fix crash if building with no GCT selected
* Fix crash if building with no GCT selected.
* Other code cleanup and misc. fixes
* Other code cleanup and misc. fixes.
'''v1.0'''
'''v1.0'''
* The first release of BrawlBuilder!
* The first release of BrawlBuilder.


==Credits==
==Credits==
Line 76: Line 71:
* And thanks to the creators of all the ISO builder scripts for Project M and the like, they are what I initially based this off of.
* And thanks to the creators of all the ISO builder scripts for Project M and the like, they are what I initially based this off of.


==External Links==
==External links==
* GitHub - https://github.com/mogzol/BrawlBuilder
* Smashboards - http://smashboards.com/threads/432675
* Smashboards - http://smashboards.com/threads/432675
* Gbatemp - https://gbatemp.net/threads/how-to-properly-build-an-iso-of-project-m-inc-wi-fi-instructions.441293/
* GBAtemp - https://gbatemp.net/threads/how-to-properly-build-an-iso-of-project-m-inc-wi-fi-instructions.441293/
* Github - https://github.com/mogzol/BrawlBuilder

Revision as of 08:21, 4 April 2023

BrawlBuilder
Brawlbuilderwii2.png
General
Authormogzol
TypeHack Utilities
Version1.2.3
LicenseMIT License
Last Updated2016/09/27
Links
Download
Website
Source

BrawlBuilder is a tool to build modded SSBB ISOs. It supports many Brawl mods, but there may be some problems. Project M versions 3.6 and above work well, including support for sfx .sawnd files and alternate stages.

Most Project M mods should also work, but Legacy M is not currently supported. Compatibility with other Brawl mods is uncertain, but anything using BrawlEx will not work beyond version 2.x.6. It is hoped that compatibility will improve in the future. For discussion or issues with BrawlBuilder, visit the official thread on Smashboards.

User guide

Command line arguments:

  • --show-wit - This will show the wit command line windows rather than hiding them and displaying the progress in the UI.
  • --show-wit-debug - This will do the same thing as --show-wit, but it will keep the wit windows open once wit closes, allowing you to read the output and figure out what is going wrong.
  • --no-gct-patch - This will disable patching of the GCT based on the CodePatches.txt file in the Resources folder. Use of this option is not recommended.
  • --notify-gct-patch - This will notify you of how many GCT patches were applied from the CodePatches.txt file.
  • --no-alt-pad - This will disable alternate stage padding. Alternate stages are padded to the size of their largest alt. Disabling this will cause any alternate stage that has a file size greater than its non-alt version to stop working.
  • --offset=X - This will change the offset that the GCT is applied at (by default 80570000) to whatever X is. Setting this to 80568000 will allow Legacy M to progress a bit further than it normally does before crashing. If your mod isn't working check its gameconfig.txt for the codeliststart line, and try using the offset listed there. Note that Resources/patch/PatchCommon.xml also patches some stuff to 8057 and 0000, don't know if that's related, but you could try editing that to match your codeliststart as well and see if it helps.

Notes

BrawlBuilder attempts to patch any GCT files you give to it in order to fix numerous problems caused by loading files from disc instead of SD. The original GCT won't be modified, patches are applied to a temporary copy of it. GCT files are patched based on the CodePatches.txt file in the Resources folder. That file currently contains patches allowing for alternate stage compatibility, replacement soundbank engine compatibility, and P:M 3.6 support in general. Feel free to modify the CodePatches file with your own patches, there is a brief description of how to use it in the comments at the top of the file.

If you are experiencing issues when playing the output ISO, make sure that you either don't have an SD card inserted, or your SD card doesn't have any mod files on it, as most mods (depending on the GCT patches that get applied) will still try to load from SD before loading from disc. In Dolphin, to eject the SD card just go in to the 'Config' menu, then go to the 'Wii' tab and untick 'Insert SD Card'.

If you are building this from source, make sure the Resources folder from the base directory is getting copied into the same directory as the exe file, or else nothing will work. This should happen automatically on build, but if it doesn't, just copy it manually.

Screenshots

brawlbuilderwii3.png

Media

How to make a Project M ISO. (FancySC)

Changelog

v1.2.3

  • The necessary parts of Ookii.Dialogs (i.e., the folder select dialog) are now compiled into the BrawlBuilder executable, which means the external DLL is no longer required. This should fix the issues some people are having with their computer blocking the DLL.

v1.2.2

  • Fix custom working directories not working (again).

v1.2.1

  • Remove the BrawlBuilder.exe.config file.
  • Fix 'Custom banner' browse button appearance for certain Windows versions/themes.

v1.2

  • Fix some stages glitching/crashing due to improper .rel files.

v1.1.2

  • Fix BrawlBuilder not working with custom working directories.

v1.1.1

  • Hopefully this will fix the 'wit exited with error code -1' error some people are receiving. I haven't been able to produce the error myself, so I can only guess at what is causing it.
  • Add 'Finalizing...' status at end of build so it doesn't seem like build is frozen at 99%.

v1.1

  • Improve error messages, most of them should now actually be somewhat helpful.
  • Fix "Build Completed" sometimes appearing even if the build did not complete properly.
  • Add the --show-wit-debug option to show wit windows and keep them open after wit closes.
  • Modify the help text for the Brawl ISO to clarify how the ssbb.d folder works.
  • Fix crash if building with no GCT selected.
  • Other code cleanup and misc. fixes.

v1.0

  • The first release of BrawlBuilder.

Credits

  • First of all, thanks to Wiimm for his amazing wit tool, which is used to extract, patch, and build the game images.
  • Secondly, thanks to the Dolphin team for the awesome debug mode of Dolphin, I wouldn't have been able to get alternate stages and the replacement soundbank engine working without that.
  • The folder select dialog uses Ookii dialogs, a great little library for nice looking dialogs.
  • Detailed wit error messages make use of FlexibleMessageBox by JReichert
  • And thanks to the creators of all the ISO builder scripts for Project M and the like, they are what I initially based this off of.

External links

Advertising: