mirror of
https://github.com/zeldaret/mm.git
synced 2026-05-24 07:10:44 -04:00
EllipticEllipsis
d5b71bd0f5
* ObjTree OK, data imported * EnMs OK, data imported * And the spec * OK * Some minor edits * A lot of preliminary stuff * Mostly complete beginning * First draft of other functions doc * Whoops, forgot the GlobalContext pad * Draw functions (minus colour), create Data * Data * gitignore, some progress on documenting * Review comments, continue documenting * spec * Finish off documentation * undefined_syms * Add a couple of todos * One more * At least add tools for object decomp * Start conversion table stuff * Document ObjTree * Document EnMs * Add more tables to conversions * Maide's review * Review * Review * Typos and incomplete thoughts * Update vscode.md * Correct function/variable names * Review suggestions * Format * Missed one * Rename functions and format * Fix ObjTree * Update actorfixer.py, fix some variable names * Some review * Review suggestions * More review * Hopefully fix all the thisx references * Missed one
57 lines
2.1 KiB
Markdown
57 lines
2.1 KiB
Markdown
# 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](../../README.md))
|
|
- Most of us use VSCode. Some useful information is [here](vscode.md).
|
|
<!-- Feel free to document Emacs/Vi/Sublime/whatever if you're familiar with them -->
|
|
- Choosing a first actor (You want something small that has simple interactions with the environment. A simple NPC can also work, and is what we will use as an illustration for most of the tutorial. There is a collection of actors we think are suitable for beginners on the spreadsheet or Trello)
|
|
|
|
## 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
|
|
|
|
- [The rest of the functions in the actor](other_functions.md)
|
|
- Order of decompilation
|
|
- Action Functions and other functions
|
|
|
|
- [Draw functions](draw_functions.md)
|
|
|
|
- [Data, migration and non-migration](data.md)
|
|
- Importing the data: early and late
|
|
- Segmented pointers
|
|
- Fake symbols
|
|
- Inlining
|
|
|
|
## [Object Decompilation](object_decomp.md) (TODO)
|
|
- Object files
|
|
- How we decompile objects
|
|
|
|
## After Decompilation
|
|
|
|
- See the [CONTRIBUTING.md](../../CONTRIBUTING.md) for most of the details for submitting PRs. Remember to format again after making adjustments from reviews!
|
|
- More information about specific preparations is in [this document](merging.md).
|
|
|
|
## Appendices
|
|
- [Types, Structs and Padding](types_structs_padding.md) (a miscellany of useful stuff)
|
|
- [Advanced control flow](advanced_control_flow.md) (an example of a more complex function which mips2c is not so good at)
|
|
- [Using the diff script and the permuter](diff_and_permuter.md) (using the diff script and the permuter to match something)
|
|
- control flow (branches) -> instruction ordering -> register allocation -> stack
|
|
- [Helper scripts] TODO: link when merged
|
|
|
|
To be written, maybe
|
|
|
|
- How we use git and GitHub
|
|
- Some notes on the basic structure of N64 MIPS
|
|
- Glossary
|
|
- Conventions
|