The-Homebrew-Cloud/BrawlBuilder
2
0
Fork 0
mirror of https://github.com/mogzol/BrawlBuilder.git synced 2024-06-24 11:56:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source 
Also add a txt readme for releases.
This commit is contained in:
Mogzol 2016-03-07 21:45:43 -08:00
parent 3f81227d25
commit 5fe4d69868
2 changed files with 118 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
Other/readme.txt Normal file
View File

@ -0,0 +1,93 @@
------------------------------------/
------- BRAWLBUILDER v1.0 -------/
------------------------------/
"The Ultimate Super Smash Bros Brawl ISO Builder"
https://github.com/mogzol/BrawlBuilder
----------------/
------ About --/
--------------/
This is a tool to build modded SSBB ISOs. It currently works with many Brawl mods, although there are some issues.
All versions of Project M should run fine, including 3.6 and above, with full support for sfx .sawnd files and
alternate stages. Most Project M mods should work as well. Psycho Ghost's 3.6 build has been tested and seems to
work fine. Legacy M, however, does not work at this time.
Other Brawl mods may or may not work, they are widely untested. It seems like anything using BrawlEx, however,
does not work at this time, so all Brawl- versions beyond 2.x.6 will not work.
Hopefully compatibility will be improved in the future.
---------------------------------/
------ Command Line Arguments --/
-------------------------------/
There are a couple command line arguments if you want to use them, I will probably add more in the future.
'--show-wit'
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.
'--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, I don't know if thats related, but you
could try editing that to match your codeliststart as well and see if it helps.
----------------/
------ Notes --/
--------------/
Note #1:
--------
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.
Note #2:
--------
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'.
Note #3:
--------
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.
------------------/
------ 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.
- 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.

38
README.md
View File

@ -2,25 +2,37 @@
The Ultimate Super Smash Bros Brawl ISO Builder
## About
This is a tool to build modded SSBB ISOs. As far as I know, it should work with pretty much any Brawl mod, the only ones that may cause issues are Project M 3.6 and above. Currently, vanilla P:M 3.6 works, including alternate stages, as do many 3.6-based mods. 3.61 Community Complete also works, if you're into that sort of thing. Legacy M 1.21 does not currently work, and I assume that some of the other more complex 3.6-based mods also won't work.
This is a tool to build modded SSBB ISOs. It currently works with many Brawl mods, although there are some issues. All versions of Project M should run fine, including 3.6 and above, with full support for sfx .sawnd files and alternate stages. Most Project M mods should work as well. Psycho Ghost's 3.6 build has been tested and seems to work fine. Legacy M, however, does not work at this time.
Other Brawl mods may or may not work, they are widely untested. It seems like anything using BrawlEx, however, does not work at this time, so all Brawl- versions beyond 2.x.6 will not work.
Hopefully compatibility will be improved in the future.
## Command line arguments
There are a couple command line arguments if you want to use them, I will probably add more in the future.
`--show-wit`
This will show the wit command line windows rather than hiding them and displaying the progress in the UI.
`--show-wit` Will show 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.
`--offset=X` 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.
`--notify-gct-patch`
This will notify you of how many GCT patches were applied from the CodePatches.txt file.
## Notes on Project M 3.6
Project M 3.6 support is achieved by through slightly modifying the given GCT. If the builder detects that you are using a 3.6+ GCT file, it will ask if you want to attempt to fix known problem codes. The first code that is changed is the stock icons code. I don't know why the code caused a lockup at startup, but I just have it set up to modify that code to what the netplay build uses, which seems to work fine. Alternate stage support is achieved through my own mod of the SD loader code, where instead of trying to load from SD, it tries to load from disc. Unfortunately, I found that if the alternate stage is larger than the normal stage, it will crash, so to solve this I just set up the builder to pad the default stage files to be the same size as their largest alternate stage. While not the most elegant solution, it works.
`--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.
## Other notes
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 mods will still try to read from the SD before reading from the disc (unless you are on P:M 3.6 and told the builder to fix problem codes, and even then, some files are still loaded from SD).
`--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.
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.
## 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.
## 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 working without that.
The folder select dialog uses Ookii dialogs, a great little library for nice looking dialogs.
And thanks to the creators of all the ISO builder scripts for Project M and the like, they are what I based this off of.
- 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.
- 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.