summaryrefslogtreecommitdiff
path: root/docs/tutorial
AgeCommit message (Collapse)Author
2024-08-02Remove tutorial, link to the latest zeldaret/oot:main revision with it (#2013)Dragorn421
* Remove tutorial, link to the latest zeldaret/oot:main revision with it * proofreading here too * rename to decompiling_tutorial --------- Co-authored-by: fig02 <fig02srl@gmail.com>
2024-07-28Configure incbins in version config instead of using the Debug ROM (#2005)cadmic
* Run CPP for data/*.s * Configure incbins in version config instead of using the Debug ROM
2024-03-04Colliders: change "touch, bump" to AT and AC (elems) (#1637)Dragorn421
* toucherFlags, bumperFlags -> atElemFlags, acElemFlags * TOUCH_ -> ATELEM_ * BUMP_ -> ACELEM_ * ColliderElementTouch,Bump -> ColliderElementDamageInfoAT,AC * toucher,bumper -> atDmgInfo,acDmgInfo * Update docs and zcolchk funcs names * run formatter * remove the last mentions of "bump" for colliders * Update renamed functions in disasm
2024-01-25Use virtualenv in Makefile for python dependencies (#1619)cadmic
* Use virtualenv in Makefile for python dependencies * Create separate targets for venv creation and installation * Fix install-python-deps prerequisite * Try simplifying Jenkinsfile * Simplify venv targets * Fix merge * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2024-01-24Setup rom decompression and compression (#1614)Anghelo Carvajal
* decompress baserom * cleanup * specific hash check * rename baserom * git subrepo clone (merge) --branch=5da3132606e4fd427a8d72b8428e4f921cd6e56f git@github.com:z64tools/z64compress.git tools/z64compress subrepo: subdir: "tools/z64compress" merged: "5da313260" upstream: origin: "git@github.com:z64tools/z64compress.git" branch: "5da3132606e4fd427a8d72b8428e4f921cd6e56f" commit: "5da313260" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596" * setup compression * Add all compressed segments to the spec * Update md5 files * readme instructions * cleanup * Setup python dependencies on Jenkinsfile * Update Makefile Co-authored-by: cadmic <cadmic24@gmail.com> * review * . .venv/bin/activate * update readme * whoops * Yeet other versions from decompress_baserom.py * my bad * Move everything to baseroms/VERSION/ * Active venv on each command * jenkinsfile: use multiline syntax * Put the correct path on the jenkinsfile * Forgot to call per_version_fixes * CC0 * Update readme * Change where baserom segments are put into * Update Makefile Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update crunch64 * Label compressed instead of uncompressed * Update README.md Co-authored-by: fig02 <fig02srl@gmail.com> * Fix * `make rom` * baserom-uncompressed * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * review * baserom-decompressed.z64 * ignore baseroms * rm -rf tools/z64compress * wip crunch64-based compress.py * OK compress * use ipl3checksum sum directly for cic update on compressed rom * multithreading * "docs" * fix MT: move set_sigint_ignored to global level for pickling * license compress.py * rm junk * Fix (or at least sort out) compress_ranges.txt dependencies * Update tools/overlayhelpers/damage_table.py Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> --------- Co-authored-by: cadmic <cadmic24@gmail.com> Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: fig02 <fig02srl@gmail.com>
2024-01-12Replace most osSyncPrintf calls with PRINTF macro (#1598)cadmic
* Replace most osSyncPrintf calls with PRINTF macro * DEBUG -> OOT_DEBUG
2024-01-05Create separate build directories based on version (#1591)cadmic
* Create separate build directories based on version * Fix find_unused_asm.sh * Remove find_unused_asm.sh from Jenkinsfile * Revert diff.py * Clarify that gc-eu-mq is not "supported" yet * Revert xmlcreate.py (to be deleted) * Remove gc-eu-mq for now * Add version flags to diff_settings.py and sym_info.py * --version -> --oot-version * Fix --oot-version * Revert adding version flags to tools * Delete find_unused_asm.sh * Revert changes to first_diff.py output in tutorial * Factor out sed usages for spec
2023-11-19More Camera Flags (#1453)engineer124
* Generic Camera Flags * New flag names * Add flags to functions * Finish flag docs * More docs * More cleanup * More clarity * Better shrinkwindow flag docs * Improve name * CAM_INTERFACE_FLAGS * Better approach to edge cases * Change ordering for consistency * Oops * Add masks to macro * PR/Discord discussions * cleanup comment * Oops * PR Suggestions * More PR Feedback * More PR Suggestions * More Camera Flags * PR Suggestions * More flag style change * Small cleanup * More flag docs * Another flag * Fix flags * sync names with other PRs * more fixes * fix comments * update with hud visibility mode docs * missed one * fix comments * Roman PR Suggestions * interfaceField * small fix * letterbox cleanup * cleanup * fix macro arg * fix func declaration * many more docs * better docs? * missed some * oops, revert * add flags to name * cleanup * flag * double signal * simplify cam func name * more suggestions * PR Suggestion
2023-10-30Remove `(ActorFunc)` casts in initvars (#1571)Dragorn421
* Remove `(ActorFunc)` casts in initvars, use `/**/` trick for format Achieved by using the following regex: (ActorInit.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*\n\};) replaced with $1$2/**/ $3$4/**/ $5$6/**/ $7$8/**/ $9$10/**/ $11$12/**/ $13$14/**/ $15$16/**/ $17$18/**/ $19 plus a change from /**/ to #if 0 #endif in docs/ * Manual fixes
2023-10-05Introduce Player CueIds (#1559)engineer124
* cueId * cleanup
2023-09-22wrong path (#1548)Nuss
2023-09-22Rename master to main (#1536)Derek Hensley
* Jenkinsfile master -> main * Missed some instances of master
2023-08-15Document z_lib Sfx Functions (#1470)engineer124
* document lib sfx * rename functions
2023-08-13Split `SaveContext` into sub-structs (#1393)Dragorn421
* Split SaveContext struct * run formatter * Remove temporary-until-split stuff in z_sram * . * run formatter
2022-12-24z_demo documentation (#1327)fig02
* commit old stuff * progress * progress * progress * progress * more progress, renaming cues next * small changes * enum values added for all actions * hardcoded values removed when possible * commands renamed * first pass of action -> cue * fix some matches * some more cleanup * scriptPtr * forgot one * remove cue rot union * more changes * some more stuff * more stuff * fix matching issues * some more things * progress, starting to rename destinations * small changes * name some destinations * more names * need to switch branch * progress * first pass of destination names * usages fixed * use destination enum * fix csdis * format * command descriptions * revert accidental zap changes * forgot some things * use a single macro for CutsceneCameraPoint (idk why i didnt think of this sooner) * typo * review1 * clarify ruby/sapphire comment * remove endframe for commands that dont use it * some more review * most review, but not all * scriptPtr -> script, and another small change * ocarina action * remove +1 from light settings command, change comment * actionIndex -> cueIdTemp (i guess) * _SetCueX -> _SetXFromCue * format * tweak fade out seq arg names * use spline terminology * more dragorn and engineer review * misc start/end frame note * cleanup StartPosRotFromCue vs PosRotFromCue * cleanup spline terminology * sPrevCamId -> sReturnToCamId * comment on debug cs data address * Cutscene_Init -> Cutscene_InitContext * single point types are not a list * remove todo comment * some more review * rumble struct names * some review * more review * missed one * reword pointer comment * even more review * match transition terminology with z_play * change condition and format * frame count * command specific structs with alignment * anon review * remove unneeded arg from time macro * yeet `CsCmdGeneric` * remove unused from single point types * typo * compromise attempt -- name endFrame everywhere * fixes * fix again * copied the wrong note * cutscene data note * review, format * compat defines * idk whats going on man Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-12-18Name `Actor_PlaySfx` and `Player_PlaySfx` (#1469)engineer124
* name two main actor sfx functions * adjust comments * fix double s in player * fix commas
2022-10-24Remove `const` from `ActorInit` initvars declarations (#1417)Dragorn421
2022-10-15`GameInfo` -> `RegEditor` (#1354)Dragorn421
* -> `RegsContext* gRegsContext` * Name regs-related functions * Revert naming `GameState_UpdateRegs` * -> `gRegEditor` * `Regs_InitContext` -> `Regs_Init` * remove mistakenly added file
2022-07-30Rewrite format script in python to improve speed with multiprocessing (#1331)Roman971
* Rewrite format script in python to improve speed with multiprocessing * Make format.py executable
2022-07-30Rename "Sound" to "Sfx" (#1292)engineer124
* First attempt * More * rename * more sound -> sfx / sound effect (#7) * PR Suggestions * PR Suggestions * Small fix Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: fig02 <fig02srl@gmail.com>
2022-06-06Fix asset file includes to always start with assets/ (#1260)Roman971
* Fix asset includes to consistently start with assets/ * Fix header paths in asset xmls to start with assets/ * Remove -Iassets from compiler options
2022-06-03Add enum for setup dls and name `z_rcp.c` functions (#1196)Dragorn421
* Introduce `SetupDL` enum * wip * wip * Remove comments on each setupdl index * Name setup dl functions by setupdl index * `Gfx_SetupDl` -> `Gfx_SetupDL` * Run formatter * globalctx -> play * fix regressions * `Gfx_SetupDL` -> `Gfx_SetupDL_` (add separating underscore) * `CallSetupDL` -> `SetupDL`
2022-05-21PlayState Rename (#1231)fig02
* global context -> play * fix PlayState* PlayState
2022-05-12Document Sub-Cameras (#989)engineer124
* Copying SubCam Changes from PR 908, made it to the end of bosses * Finish copying over PR * format * More cleanup * clean-up * PR Suggestions, Clean-Up, Improvement in CS * Remove substructs from fd/fd2 * format * Improve fishing * minor fix * Make CutsceneCameraDir more general * `sActiveCamMove` -> `sCamMove` * Fix conflict with object kankyo * Add CAM_ID_MAIN to object_kankyo * Improve cam cutscenes further * Revert cutscene cmd names (better for a separate PR) * At -> LookAt in the context of Cutscenes * Missed naming in diving game * Format * Fill in Ganon2 Names (now that it's matching) * format * `sActiveCamId` -> `sReturnToCamId` * activeCamId -> returnToCamId * Discord Discussions * FIRST * Move macro to bottom, comments * More suggestions * PR suggestion, cleanup comment * Oops * add comments * Adjust comment * Change edge-case * whoops Co-authored-by: fig02 <fig02srl@gmail.com>
2022-01-23Whitespace (#1112)playerskel
* remove trailing whitespaces * minor docs tweaks * some more trailing whitespaces * few more tweaks
2022-01-18Updating vscode.md (#1095)Stephen Meier
* Update vscode.md Updating vscode makedown to match what is found in the mm repository * Update docs/tutorial/vscode.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update docs/tutorial/vscode.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update docs/tutorial/vscode.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Moving vscode.md to the root of the docs folder * Update docs/vscode.md Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com> Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: Stephen Meier <stephen.meier@ibm.com> Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>
2021-12-02Cutscene Camera Commands: `POS` -> `EYE`, `FOCUS` -> `LOOK_AT` (#993)engineer124
* Cutscene Camera Commands: `POS` -> `EYE`, `FOCUS` -> `LOOK_AT` * PR Suggestion: Update names with REL_TO * Use newer name in macros, address PR comment
2021-12-01Cleanup asset xmls (#1044)Dragorn421
* Consistent order for attributes of `Texture` nodes in asset xmls * Consistent order for attributes of `Blob` nodes in asset xmls * Use `LimbType` instead of `Type` in `Limb` nodes in asset xmls * Remove space before closing `/>` in asset xmls tags
2021-11-30Misc Cleanup 2 (#1007)Dragorn421
* Cleanup `UNK_TYPE`, `UNK_PTR` usage * Add some missing empty lines after declarations * Remove some legacy comments from non-matching times * Fix some grammar (mostly "it's"/"its") * Use proper names for two symbols after ZAPD bugfix * Cleanup `place_title_cards.xml` * Use `NULL` to check against `D_8012D260` pointer * Parentheses around some macro arguments * wip proofread headers up to z64animation.h
2021-08-31Macros: `PLAYER` -> `GET_PLAYER(globalCtx)`, `ACTIVE_CAM` -> ↵engineer124
`GET_ACTIVE_CAM(globalCtx)` (#921) * PLAYER -> GET_PLAYER(globalCtx) * ACTIVE_CAM -> GET_ACTIVE_CAM(globalCtx) * PR Suggestions * formatter * Add brackets * remove from actorfixer.py * Bring back actorfixer.py change
2021-07-28z_en_ko OK (#869)mzxrules
* .data OK * Progress * push some old stuff * Finish a chain * Progress * Progress * Run mathfixer.py * Progress * match one more * Up to date * Match func_80A97610 * func_80A96FD0 * most of the way through the mega switch * small formatting thing. still stuck on the switch * start a big switch function * a little closer * done with matching for now starting objects * func_80A97738 OK! * func_80A995CC OK! * func_80A99864 OK! * en_ko OK! * Code clean-up pass * more EnKo cleanups, object_fa and object_kw1 textures documented * complete object_km1, more EnKo documentation * More documentation * delete asm * Clean-up rebase issues * bleh * Implement Dragorn's suggestions * fix spec, implement fig's suggestions * whoops (ill leave it for the docs tho lol) * whoops again * i made an ouchie * smile * last one for real Co-authored-by: Louis <35883445+louist103@users.noreply.github.com> Co-authored-by: fig02 <fig02srl@gmail.com>
2021-05-16Add every unreserved object in an automated way (#805)Anghelo Carvajal
* it's crashing * fix stuff * fix xmls * problematic objects * fix tabs * Fix suffixes * add missing new lines * Add comments to the problematic objects * Find and replace fixes * Add Fig's objects * I forgot to add a Name in a cutscene, so I'm adding it here * Update object decomp tutorial a little bit * Update problematic objects * Update docs/tutorial/object_decomp.md Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com> * Change comments * comment out a few blobs * dammit tluts * Change a bunch of objects * update the last bunch * update comments on oA11 and oB2 * Ninja-edit to fix compatibility with ZAPD's PR 142 Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>
2021-04-02Misc objects problems (#748)Anghelo Carvajal
* fix hidan door Signed-off-by: angie <angheloalf95@gmail.com> * doors and lens of truth in gameplaykeep Signed-off-by: angie <angheloalf95@gmail.com> * other minor fixes Signed-off-by: angie <angheloalf95@gmail.com> * Fix a typo Signed-off-by: Angie <angheloalf95@gmail.com>
2021-03-31OnePointDemo OK (#719)petrie911
* matches * more matches * progress? * it's time * so close * organize declarations * docs * more fixes * more fixes * fix stage 1 * more fixes * first try * demo ids in decimal * final cleanup * one more thing * fixes * more cleanup * onepointcs * OnePointCutscene Co-authored-by: petrie911 <pmontag@DESKTOP-LG8A167.localdomain>
2021-03-27Update asm_processor and use static variables in En_Torch2 (#740)Roman971
* Update asm_processor to current master * Update variables in En_Torch2 to actually be static This is now possible because asm_processor was updated to handle static symbols in GLOBAL_ASM * Update tutorial to reflect changes about static symbol limitations
2021-03-24Tutorial docs (#715)EllipticEllipsis
* Move tutorial into docs folder * Merge remote-tracking branch 'upstream/master' into tutorial_docs * Object decomp added * contents and intro updates * mention object decomp in beginning * Addressed Fig's review * Update EnSkb to jointTable and morphTable * minor table tweak * typo * Alter to say ZAPD makes the object output folder * Apply suggestions from code review Co-authored-by: Anghelo Carvajal <anghelo.carvajal.14@sansano.usm.cl> * More review changes * Apply suggestions from code review Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> Co-authored-by: Anghelo Carvajal <anghelo.carvajal.14@sansano.usm.cl> Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>
generated by cgit v1.2.3 (git 2.25.1) at 2026-08-04 02:43:53 +0000