phantasmal-world/FEATURES.md

# Feature Overview

Features that are in ***bold italics*** are planned and not yet implemented.

## Create New Quest

- ***Support for episodes I, II and IV***

## Load Quest

- Open file button
- Support for .qst (BB, ***GC***, ***PC***, ***DC***)
- ***Notify user when and why quest loading fails***
    - ***Deal with missing DAT or BIN file in QST container file***

## Save Quest

- Save as button
    - Save as dialog to choose name
- Support for .qst (BB, ***GC***, ***PC***, ***DC***)
- ***Notify user when and why quest saving fails***
- Custom text-based format
    - Usable with SCM tools

## Undo/Redo

- Undo/redo stack
- Undo/redo buttons
- Undo/redo key bindings

## Area Selection

- Dropdown menu to switch area
- Change area variant by editing assembly
    - Update 3D view automatically

## Simple Quest Properties

- Episode
- Editable ID, name, short and long description
    - Undo/redo
- NPC counts

## 3D View

- Area geometry
    - Collision geometry (c.rel)
    - ***Rendering geometry (n.rel)***
        - ***Textures***
- NPC/object geometry
    - Textures
- ***Transparency***
    - ***Order independent transparency***
- ***Mini-map***
- ***Top-down view (orthogonal view might suffice?)***
- ***Add "shadow" to entities to more easily see where floating entities are positioned***
    - ***MVP: a single line***
- ***Show positions and radii from the relevant script instructions***

## NPC/Object Manipulation

- Creation
    - Drag and drop from a list of NPCs/objects
- Deletion
    - "Delete" key binding
- Translation
    - Via 3D view
    - Via entity view
- Rotation
    - Via 3D view
    - Via entity view
- ***Multi select and translate/rotate/edit***

## Events

- ***Create events***
- ***Delete events***
- ***Edit events***

## Script Object Code

- Disassembler
- Assembler
- Instructions
- Simplified stack management (push* instructions are inserted transparently)
- Data
    - Binary data
    - Strings
- Labels
- Interpret code called from NPCs and objects as code

## Script Assembly Editor

- Instructions
- Data
    - Binary data
    - Strings
- Labels
    - ***Show in outline***
- Auto-completion
    - Segment type (.code, .data)
    - Instructions
- ***Go to label***
- ***Warnings***
    - ***Missing 0 label***
    - ***Missing floor handlers***
    - ***Missing map designations***
    - ***Threads (thread, thread_stg) that don't have a sync***
    - ***Unreachable/unused instructions/data***
        - ***Instructions after "ret" instruction***
        - ***Unused labels***
    - Unnecessary section markers
- Errors
    - Invalid syntax
    - Invalid instruction
    - Invalid instruction arguments
    - ***Invalid label references***
    - ***Mark all duplicate labels (the first one is not marked at the moment)***
- Instruction parameter hints
- ***Show instruction documentation on hover over***
- ***Show reserved register usage on hover over***
- ***When saving, ask user whether to really save when asm contains errors***
- ***Theme selection***

## Enemy Waves

- ***Figure out how they work***

## Non-BlueBurst Support

- ***Support different sets of instructions (older versions had no stack)***

## Bugs

- [3D View](#3d-view): Random Type Box 1 and Fixed Type Box objects aren't rendered correctly
- [3D View](#3d-view): Some objects are only partially loaded (they consist of several separate models)
    - Forest Switch
    - Laser Fence
    - Forest Laser
    - Switch (none door)
    - Energy Barrier
    - Teleporter
- [Load Quest](#load-quest): Can't parse quest 125 White Day