Voxel9 / CheatX

Open-source cheat plugin for the Original Xbox.
https://voxel9.github.io/CheatX
GNU General Public License v2.0
17 stars 2 forks source link

Code loading via text files #2

Open Voxel9 opened 4 years ago

Voxel9 commented 4 years ago

Now that the Xbox plugin has a powerful-enough search function to create cheats with, it will be imperative to produce a *.txt code loader with a suitable markdown and file name scheme.

It's important that both these schemes should be suitable for end-users to understand, as well as the developers, as they'll soon be creating and sharing around these txt files and need to know where to place them.

For a file naming scheme, I propose something as simple as using the game's Title ID (in hex) and placing it at a location such as E:\devkit\dxt\CheatX\txtcodes\*.txt, for example 4D530051.txt will be a cheat file for Conker Live and Reloaded.

As for markdown, I don't have a solid proposal just yet, but I'm thinking about something similar to the 3DS's CTRPF AR codes in the sense that the first hex digit represents a certain functionality of that particular line. (e.g. 00123456 000003E7) For code titles, something as simple as a dollar $ sign preceeding the name will suffice. And finally, comments within the txt file can be marked with a preceeding hashtag #.

Voxel9 commented 4 years ago

Some basic functionality has just been pushed.

The markdown is currently as follows:

# <TEXT> - Comments
$ <TEXT> - Code Title
0xxxxxxx xxxxxxxx (arg 1 = <ADDR>, arg 2 = <VALUE>) - Freeze value at address

I just realized that 3DS CTRPF's AR codes use square brackets [] for the title, but I'm still happy to continue using the dollar $ sign to indicate titles in CheatX.