Skip to content

Commit 8f730ab

Browse files
Update README.md
1 parent ea967e5 commit 8f730ab

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,23 @@ Various options have to be set to properly use the command line tool.
1212
| - | - |
1313
| -h | Shows a help text explaining all the options listed here and examples on how to use use them. |
1414
| -o | The operation to execute. Has to be followed by either:<br>`d` to decompress a script<br>`e` to extract a script to human readable code<br>`c` to create a scripot from human readable code |
15-
| -t | The type of .xq file to process. Is only necessary for operation `c`. Has to be followed by either:<br>xq32<br>xseq |
16-
| -f | The file to execute the operation on. |
15+
| -t | The type of .xq file to process. Is only necessary for operation `c`. Has to be followed by either:<br>`xq32`<br>`xseq` |
16+
| -f | The file or directory to execute the operation on. |
17+
18+
### Method name mapping
19+
20+
In the file `methodMapping.json` instruction types, that are not known by the program (see "Instructions" in the script specification), can be mapped to a human readable name.<br>
21+
Since those unknown instructions are normally game specific logic, they have to be figured out by the user and added to the mapping for themselves.
22+
23+
If an unknown instruction type has no corresponding mapping, its name will be set to `subXXX`, where `XXX` is the instruction type.
24+
25+
### Reference scripts
26+
27+
Scripts can call methods from within themselves and other scripts currently loaded in the engine. Normally, those calls happen via the CRC32/CRC16 of the function name to invoke them.<br>
28+
To resolve those checksums back into human readable names, reference scripts can be placed in the folder `reference` next to the command line tool.
29+
30+
It is recommended to put every script of a game in the references to have the highest probability of properly resolving all checksums.<br>
31+
However, there is no guarantee that a checksum will be resolved, so user action has to be taken.
1732

1833
## Examples
1934

0 commit comments

Comments
 (0)