Files
oracle-of-secrets/Docs
scawful 3ceab24c7c Fix Menu System issues: Journal tilemap, Ocarina selector, and input regression
- Fixed: Journal tilemap not updating by ensuring 5 (Palette/Refresh) flag is set in Menu_Journal and other submenus.
- Fixed: Ocarina menu not clearing main menu selector by realigning Menu_ItemCursorPositions to match Menu_AddressIndex, resolving a data mismatch.
- Fixed: Input entirely breaking in the menu (regression from previous commit) by reverting bash116 update flag from 3 back to 2, which seems to prevent VBlank timing issues.
- Updated Docs/GEMINI.md with recent debugging insights covering processor status mismatch, input polling, VRAM update flags, data table mismatches, and custom NMI handlers.
2025-11-22 17:50:29 -05:00
..
2025-10-03 16:07:58 -04:00

Oracle of Secrets Documentation

Welcome to the documentation for Oracle of Secrets. This directory is organized to help you find information about the project's architecture, systems, and content.

Directory Structure

  • ./General/: High-level project information, including development guidelines and build instructions.
  • ./Core/: Documentation for the core engine components, such as memory maps, the player engine (Link.md), and system interaction analysis.
  • ./Features/: Detailed analysis of major gameplay features.
    • ./Features/Items/: Information on custom and modified items.
    • ./Features/Masks/: Details on the mask transformation system.
    • ./Features/Menu/: Analysis of the custom menu and HUD.
    • ./Features/Music/: Guide to the music system and composition workflow.
  • ./World/: Information about the game world's construction.
    • ./World/Overworld/: Documentation for the overworld engine, including ZSCustomOverworld and the time system.
    • ./World/Dungeons/: Details on dungeon mechanics and custom features.
  • ./Sprites/: Analysis of all sprite types, including bosses, NPCs, and interactive objects.
  • ./Guides/: Step-by-step guides and tutorials, such as the sprite creation guide and the main quest flowchart.

Key Documents

  • General/DevelopmentGuidelines.md: The primary guide for coding standards, architecture, and best practices. Start here to understand the project's philosophy.
  • Core/MemoryMap.md: A comprehensive map of custom WRAM and SRAM variables.
  • Guides/QuestFlow.md: A detailed walkthrough of the main story and side-quest progression.
  • Guides/SpriteCreationGuide.md: A tutorial for creating new custom sprites.
  • World/Overworld/ZSCustomOverworld.md: A deep dive into the data-driven overworld engine that powers the game world.