trysdyn/bcexparse
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update readme to mention BCCE support

Browse source
This commit is contained in:
Trysdyn Black 2024-06-30 22:59:21 -07:00
parent 86f6e85785
commit 9c3c02d959
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -4,6 +4,8 @@ FF6 BCEX Spoiler Log to JSON Parser
## Usage
This tool uses only the Python standard library; no packages are needed.
`./main.py <spoiler log filename.txt>`
It's recommended to pipe the output to `jq` or a similar json parsing tool.
@ -21,3 +23,7 @@ Other uses can include presenting randomization data in a way it can be studied
The parser is quite brittle since the inconsistency of the original spoiler log format requires it to make assumptions about data structures. It is likely future versions of BCEX will break it.
Additionally the tool only parses spoiler log data needed for known use-cases, so if you plan to use it you may need to request the inclusion of spoiler log sections. The tool can be expanded by adding new functions named `parse_SECTION` where `SECTION` is the full name of a section in the log, as presented in the log.
BCCE (The community revival of the BCEX project) is supported, but support is geared toward taking BCCE's spoiler logs and producing identical output to BCEX. This means stats are not their own data object, but are folded into character data just like BCEX outputs it. Remonsterate is supported and inserts its data into the monsters object.
BCCE is in active development and this may break at any time; see the first paragraph in this section.