#+title: Oracle of Secrets
#+author: @scawful
#+todo: TODO ACTIVE | DONE

* Overview
The Legend of Zelda: Oracle of Secrets is a ROM hack of Link to the Past for the Super Nintendo.

The game has been in development since 2011 and is nearing completion.

This document aims to compile all the information on the game for reference as well as in tasks which are left to do before the release of the game.

- Discord: https://discord.gg/MBFkMTPEmk
- Plot Doc: https://docs.google.com/document/d/106e_dnY0EAjm3l416l4NDnpRjlUMFH8EKN_o7eiC77c
- Data Sheet: https://docs.google.com/spreadsheets/d/17mfAUalrYgu6Is1LNPlRBbqniAvRg5eNPOg7AQZ-b4U/

* Levels
** ~S0~ Shrine of Origins
*** Item: Moon Pearl
Located in the Temporal Pyramid where you get transported after your first encounter with Kydrog.

** =D1= Mushroom Grotto
*** Item: Bow
Located in the Mushroom Grotto west of the Maku Tree and Wayward Village

** =D2= Tail Palace
*** Item: Roc's Feather

** =D3= Kalyxo Castle
*** Item: Meadow Blade (Lv2 Sword)

** ~S1~ Shrine of Wisdom
*** Item: Zora Flippers
- [ ] Warp Zones to return the player to the start in case they screw up.
- [ ] Shrubs with Plentiful magic restoring items
- [ ] NPCs to help navigate the player.
- [ ] A possible heart-piece/treasure to reward curious players for venturing off the intended route.

** =D4= Zora Temple
*** Item: Hookshot, Zora Mask
*** TODO [0/2]
- [ ] Zora Follower Extended
- [ ] Fix Water Gate Collision

** =D5= Glacia Estate
*** Item: Fire Rod
*** TODO [0/4]
- [ ] Improve Ice Block sprite collision detection
- [ ] Tune enemies in dungeon, adjust positioning
- [ ] Exterior gfx improvements
- [ ] Add indicator for pushable block in ice puzzle

** ~S2~ Shrine of Power
*** Item: Power Glove

** =D6= Goron Mines
*** Item: Hammer
*** Dungeon Ideas

- Goron Follower
  - Requires gfx
  - Affects crumble floor cracks, can fall down

- Lifting cart to another location
  - only works if it is a small corridor so he can't walk back another route

- a puzzle similar to star puzzle in minish grotto?
  (if you step on the same star twice, you fail the puzzle).
- walk to the other side of the room without any part of the floor falling down.
  enemies or other things can make it difficult for you.
  If you fail, the door to the next room wont open.

- only some parts of the floor are normal and other parts break.
  you put an item in front of you but if it ends up on weak parts of the floor
  it falls down and you have to start over.
  kind of like somaria block try and error on invisible floors

- when you enter the room there are already cracks on the floor.
  you need an item to fix the floor so that you can walk over it once.
  maybe the song of healing

- make a crack and fall down in the right place
  so that you end up in the right place on the floor below

** =D7= Dragon Ship
*** Item: Somaria Rod
*** TODO [0/1]
- [ ] Extended section???

** ~S3~ Shrine of Courage

** =D8= Fortress of Secrets

** ~S4~ Shrine of ?????

* Quests
** Main Quests
*** Lost Ranch Girl Quest
1) Get Mushroom from Old Woman house in Mushroom Grotto
2) Trade Mushroom to Potion Shop
3) Leave Mountains and return to Potion Shop later for Magic Powder
4) Use Magic Powder on Cucco in the Ranch House for Ocarina

*** Mask Salesman Quest
1) Requires Ocarina from Lost Ranch Girl Quest
2) Mask Salesman teaches Song of Healing
3) Play Song of Healing for Deku NPC near the shop for Deku Mask

*** TODO Tail Palace Kiki Quest [1/2]
1) [ ] Kiki asks for Bananas instead of Rupees
2) [X] Deku NPCs inhabit Tail Palace OW after dungeon completion

*** Book of Secrets
1) Play Song of Healing for sick village child for Running Boots
2) Use Running Boots to get the Book from the village library.

*** TODO Kalyxo Castle
**** Bridge Opening
+ Requires Book of Secrets from Wayward Village library.
**** TODO Prison Sequence [0/2]
1) [ ] Occurs after obtaining the Meadow Blade in Kalyxo Castle
2) [ ] Ambushed by castle guards and locked away in castle prison

*** TODO Zora Sanctuary
**** ACTIVE Sea and River Zora Conflict
- [X] Meet lone Sea Zora left at the Sanctuary, learn of Zora Princess
- [X] Conflict over territory lead to Zora Princesses imprisonment
- [ ] Restore River Zora King NPC ?

**** ACTIVE Waterfall Song of Storms Event

*** Old Man Mountain Quest
1) Take the warp portal at the northwest most point on Mount Snowpeak
2) Enter the Lava Lands cave to find the Old Man.
3) Escort the Old Man to a rock formation on the mountain and use magic mirror.
4) Receive the Goldstar before continuing to Glacia Estate

*** ACTIVE Goron Mines Quest [2/4]
1) [X] Collectible Goron Rock Meat from Lupo Mountain
   - Eon Gorons workers protesting labor, Piratians involved somehow
   - Requires Power Glove from Shrine of Power
2) [X] Kalyxian Goron NPC in the desert asks for five sirloins to open the mines.
3) [ ] Garo NPC easter egg warps around the map
4) [ ] Gossip Stones provide some hint related to the Shrines?

** Side Quests
*** Masks for Sale
**** Bunny Hood - 100 Rupees
**** Stone Mask - 850 Rupees
*** Wolf Mask Quest
1) Wolfos appears outside of Kalyxo Castle at Night, defeat and play Song of Healing for Wolf Mask.
*** DONE Magic Bean Quest [4/4]
1) [X] Buy Magic Bean from Bean Vendor, requires Bottle.
2) [X] Take Magic Bean to the Ranch and plant it in empty soil north of the houses.
3) [X] Requires rain (Song of Storms), Pollination (Good Bee) and 3 in game days.
4) [X] Flower the player can ride to a heart container appears.
*** TODO Swordsmith Rescue [0/3]
1) [ ] Use the Bomb Shop Big Bomb in the Eon Abyss Beach
2) [ ] Return the Lost Brother to the Smiths house west of Waywrd Village
3) [ ] Swordsmith brothers improve your Meadow Blade to the Tempered Sword (Lv3)
*** TODO Korok Cove
*** TODO Fishing Minigame
*** TODO Dream Sequences [0/6]
- [ ] Deku Business Scrub Dream
- [ ] Twinrova Ranch Girl Dream
- [ ] Hyrule Castle Dream (Song of Time)
- [ ] River Zora King Dream
- [ ] Kydrog Sealing Dream
- [ ] Mine Collapse Dream

* Items
** Y Items
| Name            | Description                                  |
|-----------------+----------------------------------------------|
| Bow             | Vanilla                                      |
| Boomerang       | Vanilla                                      |
| Hookshot        | Goldstar ball and chain upgrade, L/R to swap |
| Bombs           | Vanilla                                      |
| Magic Powder    | Press A on menu to open Magic Bag            |
| Hammer          | Vanilla                                      |
| Lamp            | Vanilla                                      |
| Fire Rod        | Vanilla                                      |
| Ice Rod         | Freezes water tiles to walk on               |
| Magic Mirror    | Allows dual warping with all essences        |
| Ocarina         | Song of Storms, Soaring, Time, Healing       |
| Book of Secrets | Activates special overworld events           |
| Cane of Byrna   | Vanilla                                      |
| Fishing Rod     | Press Y to cast reel in water                |
| Roc's Feather   | Press Y to jump                              |
| Deku Mask       | Shoot magic bubbles, interact with Deku leaf |
| Zora Mask       | Press Y to dive underwater                   |
| Wolf Mask       | Press Y to dig for treasure                  |
| Bunny Hood      | Press R to transform and run faster          |
| Stone Mask      | Reskinned Magic Cape                         |
| Bottles         | No longer requires Bug Catching Net to use   |

** Equipment
| Name                 | Location                 |
|----------------------+--------------------------|
| Moon Pearl           | Shrine of Origins        |
| Small Sword    (Lv1) | Forest of Dreams         |
| Small Shield   (Lv1) | Forest of Dreams         |
| Meadow Blade   (Lv2) | Kalyxo Castle            |
| Tempered Blade (Lv3) | Swordsmiths Hut          |
| Master Sword   (Lv4) | Temporal Pyramid         |
| Hero Shield          |                          |
| Mirror Shield        |                          |
| Blue Tunic           | Zora Sanctuary Waterfall |
| Red Tunic            | Shrine of ??????         |
| Power Glove          | Shrine of Power          |
| Titans Mitt          | Fortress of Secrets?     |
| Running Boots        | Sick Kid Wayward Village |

** Rings
| Name           | Description                      |
|----------------+----------------------------------|
| Power Ring     | Increase attack                  |
| Armor Ring     | Increase defense                 |
| Heart Ring     | Slowly regenerate health         |
| Light Ring     | Sword beams work at -2 hearts    |
| Blast Ring     | Higher bomb damage, bombos class |
| Steadfast Ring | No knockback                     |
* Sprites
** NPCs
*** Impa
*** Maku Tree
*** Ranch Girl
*** TODO Garo
*** [#0A] Kaepora Gaebora / Eon Owl
*** [#0E] Piratian
*** [#07] Bean Vendor / Village Elder
*** [#22] Tingle
*** [#25] Village Dog
*** [#39] Sea Zora Baby
*** [#73] Farore
*** [#A0] Deku Scrub (Mask) and NPCs
*** [#B8] Zora Princess and NPCs
*** [#D7] Vasu
*** [#E8] Happy Mask Salesman
*** [#F0] Mermaid / Maple / Librarian
*** [#F1] Korok
*** [#F2] Goron
** Bosses
*** [#88] Manhandla
*** Advanced Arrghus
*** King Dodongo
*** [#CE] Twinrova
*** [#C1] Dark Link
*** Kydrog
*** [#7A] Kydreeok
** Enemies
*** [#05] Helmet Chuchu
*** [#14] Business Scrub (Kaly/Eon)
*** [#1D] Darknut (Eon)
*** [#2C] Goriya
*** Octorok (Kaly/Eon)
**** TODO Water Octorok
*** [#A4] Pols Voice
*** [#A8] Anti-Kirby
*** [#A9] Wolfos
**** Castle Variant
**** TODO Ice Variant
*** [#AE] Sea Urchin (Kaly/Eon)
*** [#B1] Puffstool
*** [#EF] Poltergeist
*** [#CC] Booki
*** [#CD] Thunder Ghost
** Objects
*** Collectibles
*** Deku Leaf
*** [#D5] Ice Block
*** Minecart
*** Mineswitch
*** Switch track
*** Portal Sprite
* Tasks
** DONE Add Librarian translations
** DONE Goron Mines Opening Animation [2/2]
- [X] Setup Goron Sprite
  - [X] Kalyxian Variant
  - [X] Eon Abyss Variant
- [X] Animate mines opening animation

** DONE Fortress of Secrets Cutscene
Should use the Ganons Tower Crystal Cutscene as the base.

** ACTIVE Fix Minecart mechanics [0/3]
- [ ] Follower cart controls
- [ ] Tile behavior for follower cart mode
- [ ] Center based hitbox detection

** ACTIVE Collectible Item Quests [2/6]
- [ ] Bananas
- [X] Pineapples
- [X] Rock Meat
- [ ] Seashells
- [ ] Honeycombs
- [ ] Deku Sticks

** ACTIVE Add Dungeon Maps [0/11]
- [ ] Mushroom Grotto
- [ ] Tail Palace
- [ ] Kalyxo Castle
- [ ] Zora Temple
- [ ] Glacia Estate
- [ ] Goron Mines
- [ ] Dragon Ship
- [ ] Fortress of Secrets
- [ ] Shrine of Wisdom
- [ ] Shrine of Power
- [ ] Shrine of Courage

** TODO Update Kydrog boss [1/3]
- [X] Track offspring sprites spawned, more dynamic spawns
- [ ] Improve Kydrog movement, add additional stage in fight
- [ ] Cinematic opening and ending cutscene with dialogue

** TODO Update Kydreeok boss [0/9]
- [ ] Improve fireball attack
- [ ] Improve head/neck rotation
- [ ] pause and neck stretch out attack ala Chain Chomp style
- [ ] neck stretch out and spin around the main body while shooting fire attack
- [ ] A bone throwing attack in the second half
- [ ] heads detach after you kill them and then float around the room like the original gleeok or like blind And then re-attach themselves instead of having them just pop back in like you have it now You could do it in both phases or just in the second bone phase
- [ ] bullet hell section where it just sucks in its heads so you can't hit it and then just shoots fireballs in every direction
- [ ] function that checks if you hit the head and if you do, don't electrocute the player to avoid some potential frustration there
- [ ] pre-fight transformation cutscene with kydrog

** TODO End Credits

* Timeline

- Beginning
  - Farore Intro
    - GameState 7EF3C5:02
    - StoryState    B6:01
  - Kydrog Intro
    - OosProg2  7EF3C6:04
    - IntroFlag 7EF300:01
  - Maku Tree Return from Eon Abyss
    - OosProg   7EF3D6:02

- Kalyxo General
  - Impa Hall of Secrets
    - OosProg   7EF3D6:04
  - Village Elder
    - MAPICON interaction
  - Ranch Kid
    - MAPICON interaction

- Toadstool Woods Mushroom -> Magic Powder from Potion Shop
- Magic Powder -> Ocarina from chicken at Toto Ranch
- Ocarina -> Song of Healing from Mask Salesman near village
- Song of Healing -> Deku Mask from Deku Scrub near Mask Shop
- Song of Healing -> Running Boots from Sick Kid in village
- Running Boots   -> Book of Secrets from village library

- Book of Secrets
  - Lifts the Kalyxo Castle gates

* ROM Map
Expanded space used by ZScream as of 1/16/2024
Addresses are PC unless stated otherwise.
ZS reserves everything up to 1.5mb or up to 0x150000

| Location            | Contents                     |
|---------------------+------------------------------|
| 0x100000 - 0x107FFF | Nothing?                     |
| 0x108000 - 0x10FFFF | Title Screen, Dungeon Map    |
| 0x110000 - 0x117FFF | Default room header location |
| 0x118000 - 0x11FFFF | Unknown                      |
| 0x120000 - 0x127FFF | Expanded overlay data        |
| 0x128000 - 0x12FFFF | Custom collision data        |
| 0x130000 - 0x137FFF | Overworld map data overflow  |
| 0x138000 - 0x13FFFF | Expanded dungeon object data |
| 0x140000 - 0x147FFF | Custom overworld data        |
| 0x148000 - 0x14FFFF | Expanded dungeon object data |
|                     |                              |

* Credits
Zarby89 - ZScream, Code, Graphics
Jared Brian - Shrine of Power, ZScream, Code
Jeimuzu - Shrine of Wisdom, Tail Palace
Letterbomb - Shrine of Courage, Music, Graphics
NEONswift - Legends of Hyrule Maps

SePH - Overworld, Graphics
Ghillie - Overworld, Graphics

DarkLink45 - Deku Link GFX

W*E*R*D*N*A - Graphics
GameyFireBro - Graphics
Fruttielicious - Beta Testing
LEGO_Vince - Beta Testing
Spacewiki - Beta Testing
Evolvingfetus - Beta Testing
Discodragn - Beta Testing
BIGLOU - Beta Testing
HonorThyFamily - Beta Testing