6ba634caa4
- Introduced detailed analysis for the Minecart system, highlighting its state machine, track system, and areas for improvement. - Created an NPCs analysis document, summarizing various NPC sprites and their functionalities. - Added an Objects analysis document, covering interactive elements like collectibles, ice blocks, and minecarts. - Documented the Overlord sprite system, detailing its role in spawning other sprites and managing events. - Compiled a Dungeons & Indoor Areas document, outlining custom room tags, enhanced mechanics, and advanced collision systems. - Developed an Overworld Systems Analysis, focusing on the ZSCustomOverworld architecture and its core features. - Added a Time System document, explaining the in-game clock and day/night cycle management. - Documented the ZScream Custom Overworld, detailing its data-driven approach and key features.
1.8 KiB
1.8 KiB
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, includingZSCustomOverworldand 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.