Commit Graph

71 Commits

Author SHA1 Message Date
scawful
a01200dd29 Update documentation and add index 2025-09-25 00:02:38 -04:00
scawful
7014d73e7b Add Comprehensive Dungeon Editor Design Plan
- Introduced a detailed design plan document for the Yaze Dungeon Editor, outlining the current architecture, main components, and core systems.
- Documented identified issues and applied fixes, including crash prevention and UI simplification, along with a roadmap for future development phases.
- Enhanced clarity on the implementation guidelines, testing strategies, and performance considerations to support ongoing development efforts.
- Established a structured approach for new developers to understand the codebase and contribute effectively to the project.
2025-09-24 23:53:29 -04:00
scawful
04909dc3d0 Add Comprehensive Guide for Yaze Dungeon Editor
- Introduced a new documentation file detailing the Yaze Dungeon Editor, covering its architecture, core components, coordinate system, object rendering system, user interface, and integration with ZScream.
- Included sections on usage examples, testing and validation strategies, and future enhancements to provide a complete overview of the editor's capabilities.
- Removed the outdated dungeon object rendering refactor documentation to streamline resources and focus on the comprehensive guide.
- Enhanced clarity and organization of the documentation to support both novice and expert users in effectively utilizing the dungeon editing tools.
2025-09-24 23:00:44 -04:00
scawful
912cc3fb56 Update overworld map properties and overlay functionality
- Changed the included assembly file for custom overworld to version 3 for improved features.
- Enhanced documentation in the overworld loading guide to clarify overlay effects and configurations.
- Refactored MapPropertiesSystem to support overlay previews and improved mosaic controls.
- Added functionality for loading vanilla overlays and displaying overlay descriptions in the editor.
- Updated UI components in OverworldEditor to integrate new overlay settings and preview options.
2025-09-24 20:16:53 -04:00
scawful
9a78f37105 Add documentation for dungeon object rendering refactor and integration test suite
- Created a comprehensive guide detailing the refactor of the dungeon object rendering system, transitioning from SNES emulation to direct ROM parsing for improved performance and maintainability.
- Documented the new architecture, including components like ObjectParser, ObjectRenderer, and Enhanced RoomObject, along with their features and implementation details.
- Added an integration test suite guide to validate ROM loading and overworld functionality, outlining test structure, execution, and best practices for adding new tests.
- Included an overworld loading guide comparing ZScream and Yaze implementations, highlighting key differences and common issues with solutions.
2025-09-24 19:06:11 -04:00
scawful
8b168864f3 Remove Python build option and update contributing documentation for clarity and structure 2025-08-21 18:58:56 -04:00
scawful
fdda77c172 Refactor ROM handling and remove SharedRom singleton for improved architecture
- Eliminated the SharedRom class to enhance modularity and reduce global state management.
- Updated various classes to directly manage ROM instances, improving clarity and encapsulation.
- Added new functions for loading messages and colors from ROM, enhancing functionality.
- Refactored Canvas and Editor classes to utilize direct ROM references, streamlining interactions.
- Improved documentation and comments for better code understanding and maintainability.
2025-08-03 17:52:02 -04:00
scawful
196eba42e8 Add roadmap towards 1.0 based on features planned 2025-01-06 21:34:25 -05:00
scawful
3fc4540479 Update changelog 2024-12-31 15:02:35 -05:00
scawful
618c33f2e8 Update infrastructure doc 2024-12-30 11:45:16 -05:00
scawful
def6f8f057 Update contributing and asm style guide docs 2024-12-30 11:42:31 -05:00
scawful
e583fd8485 Add vcpkg visual studio windows to build instructions 2024-12-30 11:42:03 -05:00
scawful
1297f2096b Update documentation 2024-11-14 13:27:42 -05:00
scawful
b4420c80aa add yaze.org for project todo tracking 2024-09-07 10:01:11 -04:00
scawful
8b9a4a867f add win32 dir for yaze.res, yaze.rc and yaze.ico 2024-08-30 02:28:11 -04:00
scawful
7e0f38ef0f housekeeping 2024-08-25 15:40:14 -04:00
scawful
f847e3b67c update yaze version 2024-08-20 22:50:35 -04:00
scawful
dc244ac02d Refactor sprite editor to use Zelda3 namespace for default sprite names 2024-08-20 21:42:50 -04:00
scawful
b1539420de add testing section to contributing 2024-08-16 15:26:41 -04:00
scawful
d86e81c58e update infra docs 2024-08-15 23:41:49 -04:00
scawful
a40928a460 update infrastructure doc 2024-08-15 23:27:53 -04:00
scawful
424ecfd4d2 update message passing doc 2024-08-15 23:19:59 -04:00
scawful
5fea72c8dd add message passing documentation 2024-08-14 23:46:37 -04:00
scawful
e869ccdb44 update getting started 2024-08-11 12:08:04 -04:00
scawful
c07114ebbb update documentation links 2024-08-11 12:03:09 -04:00
scawful
ba4700f124 housekeeping 2024-08-11 11:52:57 -04:00
scawful
231c713b38 update style guide and getting started 2024-08-11 11:49:32 -04:00
scawful
85d2b17dbb add supported features to getting started 2024-08-11 11:29:48 -04:00
scawful
3c8a72bf6c update getting started 2024-08-11 11:15:14 -04:00
scawful
3ba89b5b35 add asar structs to asm style guide data structures section 2024-08-11 11:04:03 -04:00
scawful
24507ac6d1 add style guide section to contributing doc 2024-08-11 10:48:47 -04:00
scawful
61489d8986 add 65816 asm style guide 2024-08-11 10:48:39 -04:00
scawful
caa89ed62d add contributing doc 2024-08-10 21:27:15 -04:00
scawful
c4e432cd18 update infrastructure doc 2024-08-10 21:06:44 -04:00
scawful
abd8a37197 update build instructions 2024-08-10 21:00:59 -04:00
scawful
0bda0e630a move z3ed table to getting-started 2024-08-10 20:57:49 -04:00
scawful
20289483ab rename MasterEditor to EditorManager 2024-08-10 12:23:28 -04:00
scawful
94a0fd02f6 move OverworldEditor to editor/overworld 2024-08-10 11:47:17 -04:00
scawful
8e63942ba4 update build instructions and other docs 2024-08-08 18:46:33 -04:00
scawful
e5aa9dbcd0 add changelog.md 2024-08-08 13:56:52 -04:00
scawful
bb766d22eb update documentation 2024-08-08 12:33:12 -04:00
scawful
f977211688 Remove compression.md from docs 2024-08-08 12:19:41 -04:00
scawful
f942094143 update build instructions, add iOS and GNU/Linux section 2024-08-08 01:04:41 -04:00
scawful
2d271eeb48 update getting started 2024-08-08 00:46:56 -04:00
scawful
0e0664b17a update infra docs 2024-08-08 00:42:53 -04:00
scawful
fbed06bf6c cleanup infrastructure doc 2024-08-07 14:50:59 -04:00
scawful
b3255f6687 update infra doc with build targets 2024-08-06 21:33:19 -04:00
scawful
05325e3259 Update compression documentation 2024-04-14 10:42:01 -05:00
scawful
0095b08d8c Remove redundant sections from infrastructure doc 2024-04-14 10:40:51 -05:00
scawful
4a45069334 Remove installation section from getting-started 2024-04-13 14:18:40 -04:00