thorn/kep-hack
1
0
Fork 0
mirror of https://github.com/thornAvery/kep-hack.git synced 2025-11-09 07:01:02 +13:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Music Disassembler README.txt file with output of new help parameter

Browse source 
hg-commit-id: a890db386130
This commit is contained in:
KuroiIeWa5Da 2012-01-28 06:57:52 -06:00
parent 2a46c247d9
commit ef7a524b81
1 changed files with 26 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
music/pokeredmusicdisasm/README.txt
View file

@ -1,22 +1,26 @@
to compile you must have g++ installed
type: make
and it will install to the extras folder
Usage: [<offset> [<file> | --]]
Usage: [--offset=<offset> | -o <offset>] [--file=[<file> | --] | -f [<file> | --]] [--stop=<offset> | -s <offset>]
Usage: [-h | --help]
if you want to unmake
type: make clean
and it will remove make objects and the executable
the program usage is: pokeredmusicdisasm [<offset> [<file> | --] [--stop]
offset is the rom offset in hexidecimal (FFFF or 0xFFFF)
file is the rom file, you can use -- for "../baserom.gbc"
--stop is the hexidecimal stop number
to make things quick and easy you can just enter the hexidecimal offset
pokeredmusicdisasm <offset>
to use the stop parameter you must use it as the 3rd argument as below
pokeredmusicdisasm <offset> -- --stop=FFFF
pokeredmusicdisasm <offset> <file> --stop=FFFF
you may enter limited interactive mode by not supplying any arguments
pokeredmusicdisasm
Used without parameters will start in limited interactive mode where the program will ask you the file and offset
An offset is a requirement but the file may be blank or explicitly set, whenever the file is set you may use '--' to substitute for the default file '../baserom.gbc'
If parameter options are not used the ordering is important:
There is an intentional glitch in the program, since long paramaters must be specified with --xxx= with or without a value, you may use the short option instead -xxx even though it's suppose to be -xxx=
* <offset> <file>
If parameter options are used the ordering does not matter, ensure the <offset> parameter option or parameter is present
You may mix and match parameters and parameter options, keep in mind that bare parameters must be in a certain order
If the offset parameter is missing in any way the program will prompt you for it
The program will stop parsing when it encounters mus_end regardlessly
Parameter types
* <xxx> - Bare parameter, they must be in a certain order
* -xxx=xxx - Long parameter option, it can be in any order but is case sensitive, can contain no spaces, must contain the equal sign, and is read literally
* -xxx xxx - Short parameter option, it can be in any order but is case sensitive, must contain 1 space and is read literally
----
Breakdown of parameters:
<offset> - A bare parameter, it must be in hexidecimal eith alone or prefixed with 0x and be the first parameter. It tells the parser where to start parsing
<file> - A bare parameter, it must be the second parameter and tells the parser which rom file to parse
-- - A special file path value meaning use the default file '../baserom.gbc'
--offset, -o - the parameterized offset in hexidecimal, It tells the parser where to start parsing
--file, -f - the parameterized file path, It tells the parser which rom file to parse
--stop, -s - tells the parser to stop at that hexidecimal address or until it reaches mus_end.
help, --help, -h - prints this info and exits, if the bare parameter is used it must be the first parameter