oot/docs/tutorial/contents.md

Getting started

Introduction to decomp

• 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.
• 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

  • 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

  • Order of decompilation

  • Action Functions and other functions

  • More on matching: the permuter

• Draw functions

• Data, migration and non-migration

  • Importing the data: early and late
  • Fake symbols
  • Inlining

Object Decompilation

• Object files
• How we decompile objects
• Example

After Decompilation

• Preparing to merge
  • Preliminary documentation
  • Preparing to PR
  • Pull Requests
  • Trello

Appendices

• Types, Structs and Padding (a miscellany of useful stuff)
• Helper scripts

To be written, maybe

• How we use git and GitHub
• Some notes on the basic structure of N64 MIPS
• Glossary
• Conventions