scawful/yaze
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update style guide and getting started

Browse Source
This commit is contained in:
scawful
2024-08-11 11:49:32 -04:00
parent 85d2b17dbb
commit 231c713b38
2 changed files with 39 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/asm-style-guide.md
View File

@@ -174,29 +174,31 @@ struct AncillaAdd_HookshotData $099AF8
.offset_x: skip 8
endstruct
...
AncillaAdd_Hookshot:
.speed_y
#_099AF8: db -64 ; up
#_099AF9: db 64 ; down
#_099AFA: db 0 ; left
#_099AFB: db 0 ; right
.speed_x
#_099AFC: db 0 ; up
#_099AFD: db 0 ; down
#_099AFE: db -64 ; left
#_099AFF: db 64 ; right
.offset_y
#_099B00: dw 4 ; up
#_099B02: dw 20 ; down
#_099B04: dw 8 ; left
#_099B06: dw 8 ; right
.offset_x
#_099B08: dw 0 ; up
#_099B0A: dw 0 ; down
#_099B0C: dw -4 ; left
#_099B0E: dw 11 ; right
; $099AF0
.speed_y
db -64 ; up
db 64 ; down
db 0 ; left
db 0 ; right
; $099AFC
.speed_x
db 0 ; up
db 0 ; down
db -64 ; left
db 64 ; right
; $099B00
.offset_y
dw 4 ; up
dw 20 ; down
dw 8 ; left
dw 8 ; right
; $099B08
.offset_x
dw 0 ; up
dw 0 ; down
dw -4 ; left
dw 11 ; right
```
## Code Organization
@@ -204,6 +206,7 @@ AncillaAdd_Hookshot:
- **Logical Grouping**: Organize code into logical sections, with related routines and macros grouped together.
- **Separation of Concerns**: Ensure that each section of code is responsible for a specific task or set of related tasks, avoiding tightly coupled code.
- **Modularity**: Write code in a modular way, making it easier to reuse and maintain.
- **Status Registers**: Indent code blocks when using status register operations (PHX, PLX, etc.) to improve readability.
Example:
@@ -215,6 +218,9 @@ Sprite_Minecart_Main:
{
JSR HandleTileDirections
JSR HandleDynamicSwitchTileDirections
PHX
JSR HandleMinecartMovement
PLX
RTS
}
```

17
docs/getting-started.md
View File

@@ -6,11 +6,21 @@ This editor is built to be compatible with ZScream projects and is designed to b
Please note that this project is currently a work in progress, and some features may not be fully implemented or may be subject to change.
## General Tips
- Experiment flags determine whether certain features are enabled or not. To change your flags, go to File -> Options -> Experiment Flags or in the Settings tab.
- Backup files are enabled by default. Each save will produce a timestamped copy of your ROM before you last saved. You can disable this feature in the settings.
## Supported Features
| Feature | Status | Details |
|---------|--------|-------------|
| Overworld | In Progress | Save overworld maps, entrances, exits, items, properties. |
| Overworld Maps | Done | Edit and save tile32 data. |
| Overworld Map Properties | Done | Edit and save map properties. |
| Overworld Entrances | Done | Edit and save entrance data. |
| Overworld Exits | Done | Edit and save exit data. |
| Overworld Sprites | In Progress | Edit sprite positions, add and remove sprites. |
| Tile16 Editing | Todo | Edit and save tile16 data. |
| Dungeon | In Progress | View dungeon room metadata and edit room data. |
| Palette | In Progress | Edit and save palettes, palette groups. |
| Graphics Sheets | In Progress | Edit and save graphics sheets. |
@@ -23,11 +33,6 @@ Please note that this project is currently a work in progress, and some features
| Hex Editing | Done | View and edit ROM data in hex. |
| Asar Patching | In Progress | Apply Asar patches to your ROM or Project. |
## General Tips
- Experiment flags determine whether certain features are enabled or not. To change your flags, go to File -> Options -> Experiment Flags or in the Settings tab.
- Backup files are enabled by default. Each save will produce a timestamped copy of your ROM before you last saved. You can disable this feature in the settings.
## z3ed cli
Included with the editor is a command line interface (CLI) that allows you to perform various operations on your ROMs from the command line. This aims to reduce the need for multiple tools in zelda3 hacking like Zcompress, LunarExpand, LunarAddress, Asar, and others.