From 13b58d3b91aede43dd045ed4d8f0d90ba8e83ac7 Mon Sep 17 00:00:00 2001 From: Luke Hubmayer-Werner Date: Wed, 26 Jul 2023 16:47:35 +0930 Subject: [PATCH] Add README.md --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d3baba --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# What? +Interactive Final Fantasy V save editor + +# Why? +Fun + +# How? +Godot 3.6, extracting resources from original or RPGe-translated SNES ROM. + +# How much? +Following systems are ordered by vague overarching priority: + +## 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 +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 +- [ ] Character sprites (solved problem, soon™) +- [ ] NPC sprites (solved problem, soon™) +- [ ] Vehicle sprites (solved problem, soon™) +### World Maps (Fields?) +- [ ] Tiles (solved problem, soon™) +- [ ] 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) +- [ ] 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 +- [x] Character sprites +- [ ] Weapon sprites (solved problem, soon™) +- [ ] Weapon animations (will hardcode these) +- [ ] Enemy sprites (solved problem, soon™) +- [ ] Backgrounds (solved problem, soon™) +- [ ] Enemy AI (needs research) +- [ ] 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 +This will be an interpreter, I am not hardcoding the thousands of scripts. +- [ ] Parser +- [ ] Interpreter +- [ ] API + +## Sound System +- [x] Instrument samples +- [ ] Music playing (semi-solved problem, WIP)