summaryrefslogtreecommitdiff
path: root/docs/tutorial
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tutorial')
-rw-r--r--docs/tutorial/beginning_decomp.md4
-rw-r--r--docs/tutorial/data.md28
-rw-r--r--docs/tutorial/merging.md10
-rw-r--r--docs/tutorial/object_decomp.md4
-rw-r--r--docs/tutorial/object_decomp_example.md4
5 files changed, 25 insertions, 25 deletions
diff --git a/docs/tutorial/beginning_decomp.md b/docs/tutorial/beginning_decomp.md
index b5c5e8506..49f25784e 100644
--- a/docs/tutorial/beginning_decomp.md
+++ b/docs/tutorial/beginning_decomp.md
@@ -772,7 +772,7 @@ Once preliminary cleanup and struct filling is done, most time spent matching fu
In order to use `diff.py` with the symbol names, we need a copy of the code to compare against. This is done by copying the `build` directory into a directory called `expected`. Copying in Windows on WSL is very slow, so run
```
$ mkdir expected
-cp -r build/ expected/
+cp -r build expected/
```
from the main directory of the repository. You should end up with the directory structure `expected/build/...`.
@@ -914,7 +914,7 @@ It turns out that this is enough to completely fix the diff:
Everything *looks* fine, but we only know for sure when we run `make`. Thankfully doing so gives
```
-zelda_ocarina_mq_dbg.z64: OK
+oot-gc-eu-mq-dbg.z64: OK
```
which is either a sense of triumph or relief depending on how long you've spent on a function.
diff --git a/docs/tutorial/data.md b/docs/tutorial/data.md
index 69b04c782..421bc0fe6 100644
--- a/docs/tutorial/data.md
+++ b/docs/tutorial/data.md
@@ -118,18 +118,18 @@ Now, open the file called `spec` in the base directory, find the section corresp
```
beginseg
name "ovl_En_Tg"
- include "build/src/overlays/actors/ovl_En_Tg/z_en_tg.o"
- include "build/data/overlays/actors/z_en_tg.data.o"
- include "build/data/overlays/actors/z_en_tg.reloc.o"
+ include "$(BUILD_DIR)/src/overlays/actors/ovl_En_Tg/z_en_tg.o"
+ include "$(BUILD_DIR)/data/overlays/actors/z_en_tg.data.o"
+ include "$(BUILD_DIR)/data/overlays/actors/z_en_tg.reloc.o"
endseg
```
and comment out the .data line,
```
beginseg
name "ovl_En_Tg"
- include "build/src/overlays/actors/ovl_En_Tg/z_en_tg.o"
- //include "build/data/overlays/actors/z_en_tg.data.o"
- include "build/data/overlays/actors/z_en_tg.reloc.o"
+ include "$(BUILD_DIR)/src/overlays/actors/ovl_En_Tg/z_en_tg.o"
+ //include "$(BUILD_DIR)/data/overlays/actors/z_en_tg.data.o"
+ include "$(BUILD_DIR)/data/overlays/actors/z_en_tg.reloc.o"
endseg
```
to tell the compiler not to look for the data in that file any more. Now run `make -j`, and if you did both steps correctly, you should get `OK`.
@@ -262,18 +262,18 @@ First, we tell the compiler to ignore the original data file. To do this, open t
```
beginseg
name "ovl_En_Jj"
- include "build/src/overlays/actors/ovl_En_Jj/z_en_jj.o"
- include "build/data/overlays/actors/z_en_jj.data.o"
- include "build/data/overlays/actors/z_en_jj.reloc.o"
+ include "$(BUILD_DIR)/src/overlays/actors/ovl_En_Jj/z_en_jj.o"
+ include "$(BUILD_DIR)/data/overlays/actors/z_en_jj.data.o"
+ include "$(BUILD_DIR)/data/overlays/actors/z_en_jj.reloc.o"
endseg
```
We will eventually remove both of the bottom two lines and replace them with our own reloc file, but for now, just comment out the data line:
```
beginseg
name "ovl_En_Jj"
- include "build/src/overlays/actors/ovl_En_Jj/z_en_jj.o"
- //include "build/data/overlays/actors/z_en_jj.data.o"
- include "build/data/overlays/actors/z_en_jj.reloc.o"
+ include "$(BUILD_DIR)/src/overlays/actors/ovl_En_Jj/z_en_jj.o"
+ //include "$(BUILD_DIR)/data/overlays/actors/z_en_jj.data.o"
+ include "$(BUILD_DIR)/data/overlays/actors/z_en_jj.reloc.o"
endseg
```
@@ -557,7 +557,7 @@ Ignore the first line: `gDmaDataTable` is always different if the ROM is shifted
To fix this, we use a binary diff program. A suitable one is `vbindiff`: run it on the baserom and the zelda_whatever one the compiler generates:
```
-vbindiff baserom.z64 zelda_ocarina_mq_dbg.z64
+vbindiff baserom.z64 oot-gc-eu-mq-dbg.z64
```
In this, press `g` to open up goto position, and paste in the address `0xE3ED10` from the first important line of the `first_diff` output. This gives us the following:
@@ -623,7 +623,7 @@ static ColliderCylinderInit sCylinderInit =
Running `make -j` again,
```
-zelda_ocarina_mq_dbg.z64: OK
+oot-gc-eu-mq-dbg.z64: OK
```
Hooray, we won!
diff --git a/docs/tutorial/merging.md b/docs/tutorial/merging.md
index 8ba1aa5cb..fb51b8d58 100644
--- a/docs/tutorial/merging.md
+++ b/docs/tutorial/merging.md
@@ -26,9 +26,9 @@ Specifically, to use the automatically generated reloc, rather than the original
```
beginseg
name "ovl_En_Jj"
- include "build/src/overlays/actors/ovl_En_Jj/z_en_jj.o"
- //include "build/data/overlays/actors/z_en_jj.data.o"
- include "build/data/overlays/actors/z_en_jj.reloc.o"
+ include "$(BUILD_DIR)/src/overlays/actors/ovl_En_Jj/z_en_jj.o"
+ //include "$(BUILD_DIR)/data/overlays/actors/z_en_jj.data.o"
+ include "$(BUILD_DIR)/data/overlays/actors/z_en_jj.reloc.o"
endseg
```
@@ -37,8 +37,8 @@ and change to use our reloc:
```
beginseg
name "ovl_En_Jj"
- include "build/src/overlays/actors/ovl_En_Jj/z_en_jj.o"
- include "build/src/overlays/actors/ovl_En_Jj/ovl_En_Jj_reloc.o"
+ include "$(BUILD_DIR)/src/overlays/actors/ovl_En_Jj/z_en_jj.o"
+ include "$(BUILD_DIR)/src/overlays/actors/ovl_En_Jj/ovl_En_Jj_reloc.o"
endseg
```
diff --git a/docs/tutorial/object_decomp.md b/docs/tutorial/object_decomp.md
index 480e00cd2..325239313 100644
--- a/docs/tutorial/object_decomp.md
+++ b/docs/tutorial/object_decomp.md
@@ -113,13 +113,13 @@ If in doubt, look at completed objects in the repo, and if still in doubt, ask.
Just as when you decomp an actor you have to change the `spec` to tell it to use the new files, you have to do a similar thing for the object. Find the appropriate section for the object you have decompiled, and replace the line
```c
-include "build/baserom/object_name.o"
+include "$(BUILD_DIR)/baserom/object_name.o"
```
by
```c
-include "build/assets/objects/object_name/object_name.o"
+include "$(BUILD_DIR)/assets/objects/object_name/object_name.o"
number 6
```
diff --git a/docs/tutorial/object_decomp_example.md b/docs/tutorial/object_decomp_example.md
index 38b863c19..f7317bbdd 100644
--- a/docs/tutorial/object_decomp_example.md
+++ b/docs/tutorial/object_decomp_example.md
@@ -83,7 +83,7 @@ to extract the contents of the object into the new folder, change the spec to us
beginseg
name "object_bg"
romalign 0x1000
- include "build/baserom/object_bg.o"
+ include "$(BUILD_DIR)/baserom/object_bg.o"
endseg
```
@@ -93,7 +93,7 @@ to
beginseg
name "object_bg"
romalign 0x1000
- include "build/assets/objects/object_bg/object_bg.o"
+ include "$(BUILD_DIR)/assets/objects/object_bg/object_bg.o"
number 6
endseg
```