From 37685915ffe1e0e7c5840a3163457ec554293695 Mon Sep 17 00:00:00 2001
From: Aetias <aetias@outlook.com>
Date: Fri, 29 Mar 2024 13:40:09 +0100
Subject: [PATCH] Update docs

---
 docs/actors.md   |   1 +
 docs/overlays.md | 142 ++++++++++++++++++++++++++---------------------
 2 files changed, 79 insertions(+), 64 deletions(-)

diff --git a/docs/actors.md b/docs/actors.md
index a5c8d2ee..c2c7d91e 100644
--- a/docs/actors.md
+++ b/docs/actors.md
@@ -21,4 +21,5 @@ translations. Feel free to contribute to this list!
 `ARRW` | Arrow
 `AMOS` | Armos
 `CHUC` | Chuchu
+`BMOS` | Beamos
 `PLDM` | Player Dummy | Placeholder for switching between Gongoron/Link
diff --git a/docs/overlays.md b/docs/overlays.md
index f808312b..82bee866 100644
--- a/docs/overlays.md
+++ b/docs/overlays.md
@@ -2,67 +2,81 @@
 Below is a list of all the overlays and what we call them. These can also be found in `OverlayManager.hpp`. Feel free to
 contribute to this list!
 
- ID  | Name            | Description
------|-----------------|-------------
-`00` | Core            | Core game engine
-`01` | ---             |
-`02` | ---             |
-`03` | ---             |
-`04` | Memory          | Memory management
-`05` | ---             |
-`06` | ---             |
-`07` | ---             |
-`08` | ---             |
-`09` | ---             |
-`10` | ---             |
-`11` | ---             |
-`12` | ---             |
-`13` | ---             |
-`14` | ---             |
-`15` | ---             |
-`16` | ---             |
-`17` | ---             |
-`18` | ---             |
-`19` | ---             |
-`20` | ---             |
-`21` | ---             |
-`22` | ---             |
-`23` | ---             |
-`24` | ---             |
-`25` | ---             |
-`26` | ---             |
-`27` | ---             |
-`28` | ---             |
-`29` | ---             |
-`30` | ---             |
-`31` | ---             |
-`32` | ---             |
-`33` | ---             |
-`34` | ---             |
-`35` | ---             |
-`36` | ---             |
-`37` | ---             |
-`38` | ---             |
-`39` | ---             |
-`40` | ---             |
-`41` | ---             |
-`42` | ---             |
-`43` | ---             |
-`44` | ---             |
-`45` | ---             |
-`46` | ---             |
-`47` | ---             |
-`48` | ---             |
-`49` | ---             |
-`50` | ---             |
-`51` | ---             |
-`52` | ---             |
-`53` | PlayerBoomerang | Handles the boomerang.
-`54` | PlayerScoop     | Handles the shovel.
-`55` | PlayerBomb      | Handles bombs and potions.
-`56` | PlayerBow       | Handles the bow.
-`57` | PlayerRope      | Handles the grappling hook.
-`58` | PlayerBombchu   | Handles bombchus.
-`59` | PlayerHammer    | Handles the hammer.
-`60` | ---             |
-`61` | ---             |
+ ID  | Name            | Slot | Description
+-----|-----------------|------|-------------
+`00` | Core            | 0    | Core game engine
+`01` | ---             | 1    |
+`02` | ---             | 1    |
+`03` | ---             | 1    |
+`04` | Memory          | 2    | Memory management
+`05` | ---             | 2    |
+`06` | ---             | 2    |
+`07` | ---             | 2    |
+`08` | ---             | 3    |
+`09` | ---             | 3    |
+`10` | ---             | 3    |
+`11` | ---             | 3    |
+`12` | ---             | 3    |
+`13` | ---             | 3    |
+`14` | ---             | 4    |
+`15` | ---             | 4    |
+`16` | ---             | -    |
+`17` | ---             | 5    |
+`18` | ---             | 5    |
+`19` | ---             | -    |
+`20` | ---             | -    |
+`21` | ---             | -    |
+`22` | ---             | -    |
+`23` | ---             | 6    |
+`24` | ---             | -    |
+`25` | ---             | -    |
+`26` | ---             | 6    |
+`27` | ---             | -    |
+`28` | ---             | -    |
+`29` | ---             | -    |
+`30` | ---             | -    |
+`31` | ---             | 7    |
+`32` | ---             | 7    |
+`33` | ---             | 7    |
+`34` | ---             | -    |
+`35` | ---             | -    |
+`36` | ---             | -    |
+`37` | ---             | -    |
+`38` | ---             | -    |
+`39` | ---             | -    |
+`40` | ---             | 7    |
+`41` | ---             | 8    |
+`42` | ---             | -    |
+`43` | ---             | -    |
+`44` | ---             | -    |
+`45` | ---             | 8    |
+`46` | ---             | 9    |
+`47` | ---             | -    |
+`48` | ---             | 9    |
+`49` | ---             | 9    |
+`50` | ---             | 10   |
+`51` | ---             | -    |
+`52` | ---             | -    |
+`53` | PlayerBoomerang | 11   | Handles the boomerang.
+`54` | PlayerScoop     | 11   | Handles the shovel.
+`55` | PlayerBomb      | 11   | Handles bombs and potions.
+`56` | PlayerBow       | 11   | Handles the bow.
+`57` | PlayerRope      | 11   | Handles the grappling hook.
+`58` | PlayerBombchu   | 11   | Handles bombchus.
+`59` | PlayerHammer    | 11   | Handles the hammer.
+`60` | ---             | 12   |
+`61` | ---             | 12   |
+
+## Overlay setups
+The game contains a list of "overlay setups" which contain overlay IDs to load into slot 1, 2, 3 and 12.
+
+ Index | Slot 1 | Slot 2 | Slot 3 | Slot 12 | Usage
+-------|--------|--------|--------|---------|-------
+`0`    | None   | None   | None   | None    | Game load
+`1`    | 1      | None   | 8      | None    | Startup screen (before title screen)
+`2`    | 3      | 4      | 9      | None    | Scene load
+`3`    | 1      | 6      | 10     | None    | File selection
+`4`    | 1      | None   | 11     | 61      | Wi-Fi connection setup
+`5`    | 1      | 7      | None   | None    | DS download play battle mode
+`6`    | 1      | 4      | 12     | 60      | Multi-card battle mode
+`7`    | 1      | None   | 13     | None    | Contact mode (trading items)