diff --git a/docs/getting-started.md b/docs/getting-started.md index 91378566..3807deee 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,9 +6,26 @@ This editor is built to be compatible with ZScream projects and is designed to b Please note that this project is currently a work in progress, and some features may not be fully implemented or may be subject to change. +## Supported Features + +| Feature | Status | Details | +|---------|--------|-------------| +| Overworld | In Progress | Save overworld maps, entrances, exits, items, properties. | +| Dungeon | In Progress | View dungeon room metadata and edit room data. | +| Palette | In Progress | Edit and save palettes, palette groups. | +| Graphics Sheets | In Progress | Edit and save graphics sheets. | +| Graphics Groups | Done | Edit and save graphics groups. | +| Sprite | Todo | View-only sprite data. | +| Custom Sprites | Todo | Edit and create custom sprite data. | +| Music | Todo | Edit music data. | +| Dungeon Maps | Todo | Edit dungeon maps. | +| Scad Format | Done-ish | Open and view scad files (SCR, CGX, COL) | +| Hex Editing | Done | View and edit ROM data in hex. | +| Asar Patching | In Progress | Apply Asar patches to your ROM or Project. | + ## General Tips -- Experiment flags determine whether certain features are enabled or not. To change your flags, go to File -> Options -> Experiment Flags or open the SettingsEditor tab. +- Experiment flags determine whether certain features are enabled or not. To change your flags, go to File -> Options -> Experiment Flags or in the Settings tab. - Backup files are enabled by default. Each save will produce a timestamped copy of your ROM before you last saved. You can disable this feature in the settings. ## z3ed cli