diff --git a/README.md b/README.md index b53bef5..16cf400 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,30 @@ -# supGecko -A helper library to write Gecko code +# supSMSGecko +A tool to make Gecko codes for Super Mario Sunshine. ## Installation ``` -pip install supGecko +pip install supSMSGecko ``` -## Usage +## Example ```python -from supGecko import Gecko +from supSMSGecko import make_xml, symbols, Button as B -g = Gecko() -# TODO: usage of the Gecko class -print(g.dump_txt()) +def main(g, ver): + S = symbols[ver] + addr_inst = 0x26 + S['TMarDirector::direct'] + addr_input = S['mPadStatus'] + # code + g.write16(addr_inst, 600) + g.if16(addr_input, '==', B.B | B.DL) + g.write16(addr_inst, 2400) + g.if16(addr_input, '==', B.B | B.DR, endif=True) + g.write16(addr_inst, 4800) + g.endif() + +# output the generated Gecko codes for all 4 versions to "@code.xml" +make_xml(main) ``` + +## TODO +- [ ] document of each function