====== Assembly Documentation ======

===== Overview =====

  * [[ff3:ff3us:doc:asm:credits|Credits]]
  * **Cartridge Data (ROM)**
      * [[ff3:ff3us:doc:asm:rom_map|ROM Map]]
      * [[ff3:ff3us:doc:asm:rom_map:unused_space |Unused Space]] 
      * [[ff3:ff3us:doc:asm:rom_map:unused_caption |Unused Captions]] 
  * **Memory (RAM/SRAM)**
      * [[ff3:ff3us:doc:asm:ram:field_ram| Field RAM]]
      * [[ff3:ff3us:doc:asm:ram:battle_ram| Battle RAM]]
      * [[ff3:ff3us:doc:asm:ram:menu_ram| Menu RAM]]
      * [[ff3:ff3us:doc:asm:ram:world_ram| World RAM]]
      * [[ff3:ff3us:doc:asm:ram:sound_music_ram| Sound/Music RAM]]
      * [[ff3:ff3us:doc:asm:ram:sram| SRAM]]
  * [[ff3:ff3us:doc:asm:other:compression| Compression]]
  * [[ff3:ff3us:doc:asm:algo:basic| Algorithms]]

===== Player =====
Player data is used in the Field, Battle and Menu programs.

  * Characters given to the player throughout the game are initialized with [[ff3:ff3us:doc:asm:fmt:actor_startup | Character Start Up Stats]].
  * [[ff3:ff3us:doc:asm:list:items | Items]] ([[ff3:ff3us:doc:asm:fmt:items |Item Data]]) are objects of quantity aquired ingame.
  * [[ff3:ff3us:doc:asm:list:spells | Spells]] ([[ff3:ff3us:doc:asm:fmt:spell_data |Spell Data]]) and [[ff3:ff3us:doc:asm:list:battlecommands | Battle Commands]] ([[ff3:ff3us:doc:asm:fmt:battle_command_data |Battle Command Data]]) are abilities learned by characters in the game.

  * Spell learning happens with [[ff3:ff3us:doc:asm:fmt:espers | Esper Data]] or [[ff3:ff3us:doc:asm:natural_spell_learning | Natural Spell Learning]]. Spell learning is also available through equipment (items).
  * Some game mechanics such as [[ff3:ff3us:doc:asm:list:condition_effects | Condition Effects]] and Elements have a fixed format. They can be associated with Items, Spells, Monsters or Characters.

===== Field =====
  * **Field Program (C0) - [[ff3:ff3us:doc:asm:ram:field_ram| Field RAM]]**
  * **[[ff3:ff3us:doc:asm:rom_map:field_events|Field Events (CA)]]** 
    * [[ff3:ff3us:doc:asm:codes:event_codes| Event Commands]] 
    * [[ff3:ff3us:doc:asm:codes:movement_codes| Movement Action Commands]]
  * **Field Text (CD)** ([[ff3:ff3us:doc:asm:fmt:dialogue_dte |Field DTE]])


  * [[ff3:ff3us:doc:asm:list:maps | Locations]]
    * [[ff3:ff3us:doc:asm:fmt:map_propriety | Location Properties]]
      * [[ff3:ff3us:doc:asm:fmt:map_tile_properties | Location Tile Properties]] 
      * [[ff3:ff3us:doc:asm:fmt:map_tile_sets| Location Tilesets]]
      * [[ff3:ff3us:doc:asm:fmt:bg3_graphics| BG3 Graphics]]
      * [[ff3:ff3us:doc:asm:fmt:map_animation_data | BG1/BG2 Animation Data]] 
      * [[ff3:ff3us:doc:asm:fmt:bg3_animation_data | BG3 Animation Data]] 
      * [[ff3:ff3us:doc:asm:fmt:palette_animation_data | Palette Animation Data]]
    * [[ff3:ff3us:doc:asm:fmt:entrance_event | Entrance Event]]
    * [[ff3:ff3us:doc:asm:fmt:event_trigger | Event Triggers]]
    * [[ff3:ff3us:doc:asm:fmt:npc | NPCs]] <sub>([[ff3:ff3us:doc:asm:list:actorsprites |Actor Sprites]])</sub>
    * [[ff3:ff3us:doc:asm:fmt:chest | Chests]]
    * [[ff3:ff3us:doc:asm:fmt:warp | Exits]]

===== Battle =====
  * **Battle Graphics Program (C1) - Battle Program (C2) - [[ff3:ff3us:doc:asm:ram:battle_ram| Battle RAM]]**
  * **[[ff3:ff3us:doc:asm:rom_map:battle_events | Battle Events (D0)]]**
    * [[ff3:ff3us:doc:asm:codes:battle_event_codes| Battle Event Commands]] 
    * [[ff3:ff3us:doc:asm:codes:battle_animation_script| Battle Animation Script Commands]]
  * ** Battle Text** ([[ff3:ff3us:doc:asm:dte:battle |Battle DTE]] - [[ff3:ff3us:doc:asm:dte:mp_needed | MP Needed DTE]])

  * [[ff3:ff3us:doc:asm:list:battle_backgrounds | Battle Backgrounds]]
  * [[ff3:ff3us:doc:asm:list:battle_formations | Battle Packs]]
    * [[ff3:ff3us:doc:asm:fmt:battle_data | Battle Formation]]
      * [[ff3:ff3us:doc:asm:fmt:monster_formation_flags | Battle Flags]]
        * [[ff3:ff3us:doc:asm:fmt:character_ai_data | Character AI Data]]
      * [[ff3:ff3us:doc:asm:list:monsters |Monsters]]
        * [[ff3:ff3us:doc:asm:fmt:monster_graphics_data | Monster/Esper Graphics Data]]
        * [[ff3:ff3us:doc:asm:fmt:monster_data | Monster Stats]]
        * [[ff3:ff3us:doc:asm:fmt:drop_steal | Monster Items Stolen and Dropped]] 

  * Spells in battle:
    * [[ff3:ff3us:doc:asm:fmt:attack_animation_data | Attack Animation Data]]
    * [[ff3:ff3us:doc:asm:fmt:attack_graphics_data | Attack Graphics Data]]
    * [[ff3:ff3us:doc:asm:fmt:attack_special_effect | Spell & Item Special Effects]]

===== Menu =====
  * **Menu Program (C3) - [[ff3:ff3us:doc:asm:ram:menu_ram| Menu RAM]]**
  * **Menu Text** ([[ff3:ff3us:doc:asm:fmt:menu_dte |Menu DTE]] - [[ff3:ff3us:doc:asm:dte:menu_descriptions | Menu Descriptions DTE]])

  * [[ff3:ff3us:doc:asm:fmt:colosseum_data | Colosseum Data]]
  * [[ff3:ff3us:doc:asm:fmt:shop_data | Shop Data]]
  * [[ff3:ff3us:doc:asm:list:rare_items | Rare Items]]

===== World =====
  * **World Program (EE) - [[ff3:ff3us:doc:asm:ram:world_ram| World RAM]]**
  * **World Map Events in Field Events (CA)**
    * [[ff3:ff3us:doc:asm:codes:overworld_character_script| Overworld Character Script Commands]]
    * [[ff3:ff3us:doc:asm:codes:overworld_vehicle_script| Overworld Vehicle Script Commands]]

  * [[ff3:ff3us:doc:asm:fmt:world_map_tile_properties | World Map Tile Properties]]

===== Sound/Music =====
  * **Sound/Music Program (C5) - [[ff3:ff3us:doc:asm:ram:sound_music_ram| Sound/Music RAM]]**

  * [[ff3:ff3us:doc:asm:list:music | Music Tracks]]
    * SPC Data ([[ff3:ff3us:doc:asm:codes:music_codes|Music Commands]])
    * [[ff3:ff3us:doc:asm:fmt:instrument_sets | Instrument Sets]]
      * [[ff3:ff3us:doc:asm:list:instruments | Instruments]]
  * [[ff3:ff3us:doc:asm:list:sfx | Sound Effects]]