Skip to content

Commit 5536977

Browse files
Update README.MD
1 parent 17de37c commit 5536977

File tree

1 file changed

+0
-120
lines changed

1 file changed

+0
-120
lines changed

README.MD

Lines changed: 0 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -14,125 +14,5 @@ In this mode, Link will lose rupees every X amount of seconds. Once you have 0 r
1414
* Hold d-pad down and press L to turn the terminal on/off.
1515
* Press d-pad left or right when terminal is on to switch between the game modes.
1616
* Press A when Rupee Dash Mode is selected to modify the amount of seconds.
17-
18-
## Twilight Princess - REL
19-
This is a template repository for you to create your very own Twilight Princess mod and provide a simple start to write your code. Kind of like a "hello world" for TP.
20-
21-
## Project Structure
22-
---
23-
```
24-
REL
25-
├───externals/ // Submodules or other dependencies are placed here
26-
│ │ ├───libtp_rel/
27-
│ │ │ ├───include/ // Library Header files
28-
│ │ │ ├───source/ // Library source files
29-
├───assets/ // Additional resources that are not code
30-
│ ├───gc_banner.raw // Game banner for the GCI
31-
| ├───wii_banner.raw // Game banner for the Wii save
32-
| ├───icon.raw // Game icon for the GCI
33-
│ ├───*.lst // Symbol:Address pairs for each version of the game
34-
├───bin/ // Binary files and scripts
35-
│ ├───elf2rel // Linux Binary of elf2rel
36-
│ ├───elf2rel.exe // Windows "
37-
│ ├───gcipack.py // Packs a REL into a GCI
38-
│ ├───nandpack.py // Packs a REL into a Wii save
39-
├───docs/ // Doxygen Output folder; can be used for GitHub pages - change in doxygen.conf
40-
├───include/ // Your Header (.h) files
41-
├───source/ // Your Source (.cpp) files
42-
├───Makefile // Build script
43-
├───.clang-format // clang-format configuration file
44-
├───doxygen.conf // doxygen configuration file
45-
```
46-
47-
## Getting started
48-
---
49-
This repository provides you with a solid start, you should use the predefined main function as an entry point to your mod...
50-
Please check Lines 19 through 30 in the Makefile to change some of the definitions and names.
51-
52-
You can refer to the [Randomizer](//github.com/zsrtp/Randomizer) Project for reference.
53-
54-
## Wiki
55-
---
56-
### General
57-
Our [wiki](//wiki.tprandomizer.com) is meant to be a central source of information for TP with a slightly technical focus we provide the most crucial information such as Stages & Rooms or item ids. If you're looking for information you should be looking there or ask in the [dev discord](//discord.gg/aZx8ZFcSPy).
58-
59-
### Coding guidelines
60-
If you intend to share this code with the @zsrtp community, please follow the [guidelines](//wiki.tprandomizer.com/index.php?title=Dev:Coding_Guidelines) as strictly as possible.
61-
62-
## Building
63-
---
64-
**Repository**
65-
66-
*You need to have git installed ([windows](https://git-scm.com/download/win))*
67-
68-
Open a CMD and navigate to where you want your code to be:
69-
```
70-
C:\>mkdir Code
71-
C:\>cd Code
72-
C:\Code>git clone https://github.com/zsrtp/REL.git
73-
Cloning into REL
74-
remote: Enumerating objects: 132, done.
75-
remote: Counting objects: 100% (132/132), done.
76-
remote: Compressing objects: 100% (87/87), done.
77-
remote: Total 132 (delta 56), reused 98 (delta 29), pack-reused 0
78-
Receiving objects: 100% (132/132), 1.24 MiB | 6.45 MiB/s, done.
79-
Resolving deltas: 100% (56/56), done.
80-
```
81-
Download and upate libtp_rel
82-
```
83-
C:\Code\REL> git submodule update --init --remote
84-
```
85-
Done.
86-
87-
**Dependencies**
88-
* DevkitPPC comes with [devkitPro](//github.com/devkitPro/installer/releases)
89-
* [Python3](//www.python.org/downloads) (should be added to PATH or you will likely need Makefile adjustments)
90-
* [pycryptodomex](https://pypi.org/project/pycryptodomex/) (For Wii only, dependency of [`nandpack.py`](https://github.com/kipcode66/wii_tools))
91-
* Optional: [Visual Studio Code](//code.visualstudio.com) with [GC Settings](//wiki.tprandomizer.com/index.php?title=Dev:Visual_Studio_Code)
92-
93-
**Compiling**
94-
95-
*devkitPro comes with its own MSys2 shell, it is recommended to use it for compilation.
96-
97-
This is an example of how to build for the NTSC-U version of the Game
98-
```shell
99-
$ cd /c/Path/To/REL
100-
$ make us
101-
main.cpp
102-
cxx.cpp
103-
memory.cpp
104-
patch.cpp
105-
rel.cpp
106-
tools.cpp
107-
timer.cpp
108-
stages.cpp
109-
console.cpp
110-
card.cpp
111-
color_utils.cpp
112-
texture_utils.cpp
113-
restfpr_x.s
114-
restgpr_x.s
115-
linking ... REL.us.elf
116-
output ... REL.us.rel
117-
packing ... REL.us.gci
118-
```
119-
The `REL.us.gci` (`REL.wus0.bin` for wii) (other versions are: `jp`, `eu`, `wus0`, `wus2`, `wjp`, and `weu`, as well as two other build target `gcn` and `wii` which build all the version for the specified platform) file is now containing our custom REL. Load it with the REL Loader cheat or a hacked save file that contains the loader, both of which can be found on the wiki [REL Loader](//wiki.tprandomizer.com/index.php?title=REL_Loader) page.
120-
121-
##### Injecting into an existing Wii save
122-
123-
If you wish to inject the mod into an existing Wii save instead of generating an empty save, you can use the `nandpack.py` script to do that. Here is an example:
124-
125-
```shell
126-
$ ./bin/nandpack.py inject -i 3 -g us0 -f "REL Example" REL.wus0.rel data.bin REL.wus0.bin
127-
```
128-
129-
Where:
130-
- `-i 3`: inject the mod into the 3rd slot.
131-
- `-g us0`: specify we're injecting into an NTSCU 1.0 save.
132-
- `-f "REL Example"`: set the name of the slot to `REL Example`
133-
- `REL.wus0.rel`: this is the file containing the mod itself that we want to inject into the save.
134-
- `data.bin`: this is the save file we want to inject the mod into.
135-
- `REL.wus0.bin`: this is the resulting save file with the mod injected into it.
136-
13717
---
13818
This mod is powered by [libtp_rel](//github.com/zsrtp/libtp_rel) and licensed under [GPLv3](/LICENSE) | (C) [AECX](//github.com/AECX), [LunarSoap](//github.com/lunarsoap5), [Zephiles](//github.com/Zephiles), [kipcode66](//github.com/kipcode66)

0 commit comments

Comments
 (0)