diff options
| author | EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com> | 2021-03-24 00:15:35 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-24 01:15:35 +0100 |
| commit | effd4256c983e04469d7904187ed41f25c845cfe (patch) | |
| tree | b755a284f0045cb8cced6082e631548035f76972 /docs/tutorial/contents.md | |
| parent | 5562b2ef6f582c69e20b0d7c2a3f56bcc252a5d2 (diff) | |
Tutorial docs (#715)
* 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>
Diffstat (limited to 'docs/tutorial/contents.md')
| -rw-r--r-- | docs/tutorial/contents.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/tutorial/contents.md b/docs/tutorial/contents.md new file mode 100644 index 000000000..c4a729141 --- /dev/null +++ b/docs/tutorial/contents.md @@ -0,0 +1,62 @@ +# Getting started + +## [Introduction to decomp](introduction.md) +- What we are doing +- Structure of the code + +## Pre-decompilation +- Building the repo (follow the instructions in the README.md) +- Most of us use VSCode. (You can watch Fig's video to get an idea of how this can be used). Some useful information is [here](vscode.md). +- Choosing a first actor (You want something small that has simple interactions with the environment. But OoT is far enough in that there are basically no unreserved actors left anyway now.) + +## Decompilation + +- [Begining decompilation: order, Init and the actor struct](beginning_decomp.md) + - Order of decompilation + - Init and common actor features + - Initchains + - Actors and dynapoly actors + - Colliders + - Skelanime + + - Matching + - Using diff + - control flow (branches) -> instruction ordering -> register allocation -> stack + +- [The rest of the functions in the actor](other_functions.md) + - Order of decompilation + - Action Functions and other functions + + - More on matching: the permuter + +- [Draw functions](draw_functions.md) + +- [Data, migration and non-migration](data.md) + - Importing the data: early and late + - Fake symbols + - Inlining + +## [Object Decompilation](object_decomp.md) +- Object files +- How we decompile objects +- [Example](object_decomp_example.md) + + +## After Decompilation + +- [Preparing to merge](merging.md) + - Preliminary documentation + - Preparing to PR + - Pull Requests + - Trello + +## Appendices +- [Types, Structs and Padding](types_structs_padding.md) (a miscellany of useful stuff) +- [Helper scripts](helper_scripts.md) + +To be written, maybe + +- How we use git and GitHub +- Some notes on the basic structure of N64 MIPS +- Glossary +- Conventions |