From a7b3377df66e13f875fa72632e58deb8da2f4011 Mon Sep 17 00:00:00 2001 From: Luke Hubmayer-Werner Date: Thu, 27 Jul 2023 20:05:45 +0930 Subject: [PATCH] Add summary to readme --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a097aef..83a3065 100644 --- a/README.md +++ b/README.md @@ -8,38 +8,43 @@ Fun Godot 3.6, extracting resources from original or RPGe-translated SNES ROM. # How much? + +## tl;dr +You can currently load up your SNES ROM of Final Fantasy FFV and look at battle sprites, world map tiles, and listen to the instrument samples. + +## Full Feature List (WIP) Following systems are ordered by vague overarching priority: -## Save/Load System +### Save/Load System I know I called this an "Interactive Save Editor" but I haven't started that yet. - [ ] SNES Support - [ ] PSX Support (should be identical to SNES with different offset) - [ ] GBA Support (note, does not imply full asset ripping) - [ ] Steam Pixel Remaster Support (I haven't bought this yet so low prio) (note, does not imply full asset ripping) -## Menu System +### Menu System I have mostly solved parsing of SNES menus in a sister project, however there are so few of them that hardcoding better behaviour would be nicer anyway. - [ ] Main Menu and Load/New Game - [ ] Party Menu and submenus - [ ] Shops -## Map Field System +### Map Field System - [ ] Character sprites (solved problem, soon™) - [ ] NPC sprites (solved problem, soon™) - [ ] Vehicle sprites (solved problem, soon™) -### World Maps (Fields?) +#### World Maps (Fields?) - [x] Tiles - [ ] Tilemaps (solved problem, soon™) - [ ] Dynamic changes (e.g. meteors, breaking seals, sinking island, pirate cave, voids) (might hardcode these later) - [ ] Pathing (I have vague recollections about this) - [ ] Mode 7 Effects (...might hardcode these later) -### Dungeon/Town/Zone Maps (idk what accepted terminology is) +#### Dungeon/Town/Zone Maps (idk what accepted terminology is) - [ ] Tiles (solved problem, soon™) - [ ] Tilemaps (solved problem, soon™) - [ ] Layer Effects and animated tiles (needs research, including water) - [ ] Pathing (I have vague recollections about this) -## Battle System +### Battle System - [x] Character sprites - [ ] Weapon sprites (solved problem, soon™) - [ ] Weapon animations (will hardcode these) @@ -49,12 +54,12 @@ I have mostly solved parsing of SNES menus in a sister project, however there ar - [ ] Abilities (will hardcode these, with fixes and extensions where appropriate) - [ ] Calculations (will hardcode these from Algorithms guide, with fixes and extensions where appropriate) -## Script System +### Script System This will be an interpreter, I am not hardcoding the thousands of scripts. - [ ] Parser - [ ] Interpreter - [ ] API -## Sound System +### Sound System - [x] Instrument samples - [ ] Music playing (semi-solved problem, WIP)