From cedf27485aa96604f884608059d9f55a10ca0d93 Mon Sep 17 00:00:00 2001 From: Trysdyn Black Date: Fri, 11 Oct 2024 17:57:27 -0700 Subject: [PATCH] Note unsupported log sections --- README.md | 16 ++++++++++++++++ main.py | 17 ++++++++++++++++- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56f8e6f..4bff271 100644 --- a/README.md +++ b/README.md @@ -27,3 +27,19 @@ Additionally the tool only parses spoiler log data needed for known use-cases, s 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. + +## Known Support Gaps + +These sections in the BCEX/BCCE spoiler logs currently have no logic and I'm aware of it. That doesn't mean sections *not* listed here have support; they may not and I'm not aware of them. + +- AESTHETICS +- MAGITEK +- DANCES +- ESPERS +- ITEM MAGIC +- ITEM EFFECTS +- COLOSSEUM +- MUSIC +- SHOPS +- TREASURE CHESTS +- JUNCTIONS diff --git a/main.py b/main.py index b60011c..a0f3b37 100644 --- a/main.py +++ b/main.py @@ -11,7 +11,22 @@ from pathlib import Path class Parser: - """BCEX/BCCE spoiler logfile parser.""" + """ + BCEX/BCCE spoiler logfile parser. + + Sections missing support: + - AESTHETICS + - MAGITEK + - DANCES + - ESPERS + - ITEM MAGIC + - ITEM EFFECTS + - COLOSSEUM + - MUSIC + - SHOPS + - TREASURE CHESTS + - JUNCTIONS + """ def __init__(self, filename: str) -> None: """Initialize parser with filename."""