General docs (#269)

* fox_display.c DOCS

* PRINTF

* actor->destroy boolean

* corneria docs

* Boss->unk_04C to Boss->animFrame

* aCoGrangaWalkingAnim

* more corneria docs

* Spawner

* Spawner code refined

* Spawner description

* Actor Spawn guard

* Molar Rock (name by @inspectredc)

* more docs

* actor docs

* initial disassembly config for lodgenet

* correct vram addresses for lodgenet

* Actor Docs

* More actor docs

* more actor docs

* correction

* correction

* more actor docs

* Preliminary work for Effect documentation

* Change Init for Setup

* fox_play cleanup and defake

* fox_zo function names

* fox_so function renaming

* more object docs

* venom 1 actors

* actor docs

* some fox_bo docs

* some fox_fo corrections

* fox_ma obj->this

* fox_ma renamings

* fox_ma docs

* fox_ti Actors

* revert permuter settings to ido

* some renames on fox_andross.c

* fox_sy actors

* object names

* corrections

* some effect comments

* fix AudioTable struct and data to avoid UB

* uintptr_t in audio

* audio load changes

* event id enum usage in fox_sy

* clear padding in sPlaylists

* HUD_FoBase_ExplodeCs

* HUD

4 files changed, 233 insertions, 0 deletions

diff --git a/yamls/ln/rev0/assets.yaml b/yamls/ln/rev0/assets.yaml
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/yamls/ln/rev0/assets.yaml
diff --git a/yamls/ln/rev0/header.yaml b/yamls/ln/rev0/header.yaml
new file mode 100644
index 00000000..c08b512c
--- /dev/null
+++ b/yamls/ln/rev0/header.yaml
@@ -0,0 +1,77 @@
+name: Starfox64 (Gateway 64 (NTSC))
+sha1: 3400e9c2b77fc1f1204f26a32b09b6f759746ae2
+options:
+  basename: starfox64
+  target_path: baserom.ln.rev0.uncompressed.z64
+  elf_path: build/starfox64.ln.rev0.elf
+  ld_script_path: linker_scripts/ln/rev0/starfox64.ld
+  base_path: .
+  compiler: GCC
+  find_file_boundaries: True
+  header_encoding: ASCII
+  platform: n64
+  undefined_funcs_auto_path: linker_scripts/ln/rev0/auto/undefined_funcs_auto.ld
+  undefined_syms_auto_path: linker_scripts/ln/rev0/auto/undefined_syms_auto.ld
+
+  symbol_addrs_path: 
+    - linker_scripts/ln/rev0/symbol_addrs.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_engine.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_libultra.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_nlib_funcs.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_nlib_vars.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_assets.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_mesg.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_audio.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_overlays.txt
+  #  - linker_scripts/ln/rev0/symbol_addrs_EBFBE0.txt
+  #  - linker_scripts/ln/rev0/ignored_addresses.txt
+
+  asm_path: asm/ln/rev0
+  src_path: srcln
+  asset_path: bin/ln/rev0
+
+  build_path: build
+
+  extensions_path: tools/splat_ext
+  mips_abi_float_regs: o32
+  create_asm_dependencies: True
+  do_c_func_detection: True
+  o_as_suffix: True
+  gfx_ucode: f3dex
+  mnemonic_ljust: 12
+  rom_address_padding: True
+  dump_symbols: True
+  include_macro_inc: False
+  libultra_symbols: True
+  hardware_regs: True
+
+  ld_dependencies: True
+
+
+  use_legacy_include_asm: False
+
+  asm_function_macro: glabel
+  asm_jtbl_label_macro: jlabel
+  asm_data_macro: dlabel
+
+  ld_legacy_generation: True
+  check_consecutive_segment_types: False
+
+  # section_order: [".text", ".data", ".rodata", ".bss", "bin"]
+  # auto_all_sections: [".data", ".rodata", ".bss"]
+
+  
+
+  
+  mips_abi_float_regs: o32
+  
+
+  disasm_unknown: True
+  # string_encoding: ASCII
+  # data_string_encoding: ASCII
+  rodata_string_guesser_level: 2
+  data_string_guesser_level: 2
+  # libultra_symbols: True
+  # hardware_regs: True
+  # gfx_ucode: # one of [f3d, f3db, f3dex, f3dexb, f3dex2]
+segments:
diff --git a/yamls/ln/rev0/main.yaml b/yamls/ln/rev0/main.yaml
new file mode 100644
index 00000000..d6d3ee81
--- /dev/null
+++ b/yamls/ln/rev0/main.yaml
@@ -0,0 +1,156 @@
+  - name: header
+    type: header
+    start: 0x0
+
+  - name: boot
+    type: bin
+    start: 0x40
+
+  - name: entry
+    type: code
+    start: 0x1000
+    vram: 0x80000400
+    subsegments:
+      - [0x1000, hasm]
+
+  - name: main
+    type: code
+    start: 0x1060
+    vram: 0x80000460
+    follows_vram: entry
+    #bss_size: 0x9A230
+    subsegments:
+      - [0x1060, asm]
+    #  - [0x1290, data]
+    #  - { start: 0xE44F0, type: bss, vram: 0x800E38F0 }
+
+  - name: dma_table
+    type: code
+    start: 0xE44F0
+    vram: 0x8017DB20
+    follows_vram: main
+    subsegments:
+    - [0xE44F0, data, dmatable]
+
+  - name: assets
+  # ast_logo: D28610
+  # ast_ending: D2AB10
+  # ast_ending_award_front: D46910
+  # ast_ending_award_back: D6B990
+  # ast_ending_expert: D95420
+  # ast_training: DDF520
+  # ast_radio: DE9250
+    type: bin
+    start: 0xE4A90
+  # vram: 0x800E3E90
+    follows_vram: main
+
+  - name: ovl_i1
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_i1
+    start: 0xDF7760
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: i1_$VRAM
+    subsegments:
+    - [0xDF7760, asm, fox_i1]
+
+  - name: ovl_i2
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_i2
+    start: 0xE0B930
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: i2_$VRAM
+    subsegments:
+    - [0xE0B930, asm, fox_i2]
+
+  - name: ovl_i3
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_i3
+    start: 0xE1A180
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: i3_$VRAM
+    subsegments:
+    - [0xE1A180, asm, fox_i3]
+
+  - name: ovl_i4
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_i4
+    start: 0xE55020
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: i4_$VRAM
+    subsegments:
+    - [0xE55020, asm, fox_i4]
+
+  - name: ovl_i5
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_i5
+    start: 0xE6DF00
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: i5_$VRAM
+    subsegments:
+    - [0xE6DF00, asm, fox_i5]
+
+  - name: ovl_i6
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_i6
+    start: 0xEA2850
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: i6_$VRAM
+    subsegments:
+    - [0xEA2850, asm, fox_i6]
+
+  - name: ovl_menu
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_menu
+    start: 0xEC32A0
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: menu_$VRAM
+    subsegments:
+    - [0xEC32A0, asm, fox_i_menu]
+  
+  - name: ovl_ending
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_ending
+    start: 0xEF2DB0
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: ending_$VRAM
+    subsegments:
+    - [0xEF2DB0, asm, fox_end1]
+  
+  - name: ovl_unused
+    exclusive_ram_id: overlay
+    type: code
+    dir: overlays/ovl_unused
+    start: 0xF02520
+    vram: 0x8018C5D0
+    follows_vram: assets
+    # bss_size: 0xA10
+    symbol_name_format: unused_$VRAM
+    subsegments:
+    - [0xF02520, asm, fox_unused]
+
+  - [0xF025C0]
diff --git a/yamls/ln/rev0/overlays.yaml b/yamls/ln/rev0/overlays.yaml
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/yamls/ln/rev0/overlays.yaml