summaryrefslogtreecommitdiff
path: root/docs/tutorial/introduction.md
diff options
context:
space:
mode:
authorParker Burnett <burnettparker@gmail.com>2022-07-11 17:27:49 -0700
committerGitHub <noreply@github.com>2022-07-11 20:27:49 -0400
commit3503163a640cd19f1788a58ec5abb7a57ea53b2c (patch)
tree1c6bb3b7b375818b9f5f91a094ed5b27d5a9f56f /docs/tutorial/introduction.md
parent54957f8735051610ba97d40467dd008fa1870ca2 (diff)
Adding Git information to tutorial (#862)
* Adding an intro to git with helpful commands for someone unfamiliar with git. Co-authored by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * Adding an intro to git with helpful commands for someone unfamiliar with git. Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * ovl_Obj_Y2lift decompiled (#856) * ovl_Obj_Y2lift decompiled * format * pr review fixes * clean up Co-authored-by: SonicDcer <noreply@github.com> * Formating files and moving contributing.md Also fixes links. * Adding an intro to git with helpful commands for someone unfamiliar with git. formating files too Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * pr fixes Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> Co-authored-by: Alejandro Asenjo <96613413+sonicdcer@users.noreply.github.com> Co-authored-by: SonicDcer <noreply@github.com>
Diffstat (limited to 'docs/tutorial/introduction.md')
-rw-r--r--docs/tutorial/introduction.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/tutorial/introduction.md b/docs/tutorial/introduction.md
index 99625364d..2115faace 100644
--- a/docs/tutorial/introduction.md
+++ b/docs/tutorial/introduction.md
@@ -73,12 +73,14 @@ A lot of work has already been done on the code to bring it into a format that i
An *actor* is any thing in the game that moves or performs actions or interactions: Link is an actor, enemies are actors, NPCs are actors, props like grass are actors. The vast majority of actors are *overlays*, which means they are loaded only when the game needs them.
-In the code, each actor is associated to several files: there is
+In the code, each actor is associated to several files: there is
+
- the main .c file, e.g. `src/overlays/actors/ovl_En_Ms/z_en_ms.c`
- the actor's Header file, e.g. `src/overlays/actors/ovl_En_Ms/z_en_ms.h`
-- various .o files that tell the `make` script how to incorporate it into building the ROM,
+- various .o files that tell the `make` script how to incorporate it into building the ROM,
+
+and then for undecompiled actors, various assembly (.s) files, generally including:
-and then for undecompiled actors, various assembly (.s) files, generally including:
- one for the actor's *data* (this usually includes things like its collision information about how to draw it, and various other stuff that is used in it), e.g. `data/overlays/actors/ovl_En_Ms.data.s`
- one for each function in the actor, e.g. `asm/non_matchings/overlays/actors/ovl_En_Ms/func_809529AC.s`