summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorProjectRevoTPP <projectrevotpp@hotmail.com>2020-08-26 14:35:44 -0400
committerProjectRevoTPP <projectrevotpp@hotmail.com>2020-08-26 14:35:44 -0400
commit3fca53d87d8610e48a3a6806cd4786e8a358edd0 (patch)
treeb5790047041ab78cff52bf344885d3f9b8b06f12
parent875b7e0a43f28919894e6d7d2cad7ee6ae0e8f95 (diff)
add README.md
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f2b1b39
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Pokemon Battle Revolution
+
+This repo contains a WIP decompilation of Pokemon Battle Revolution (PAL).
+
+It builds the following DOL:
+
+main.dol: `sha1: ffcd539d239722b8bb27e45c9ad4aacc818c8933`
+
+## Build Instructions
+
+1. Obtain a clean DOL of PBR PAL 1.0 and place it in the build folder and name it `baserom.dol`.
+2. Obtain a copy of the MWCC PowerPC (from GC CW 3.0) and place it in tools/mwcc_compiler/3.0/ folder in tools/. (NOTE: This compiler's executables [mwcceppc.exe mwasmeppc.exe and mwldeppc.exe] can be installed with Codewarrior 1.1 for Gamecube, but no license or crack is provided with this project. Please obtain access to the compiler on your own.) If you are in the Gamecube/Wii Decompilation discord (not public at this time, but if you are interested and have the skillset to contribute, please DM Revo#7090 on Discord for access), download GC_COMPILERS.zip and extract it to tools/mwcc_compiler/.
+3. Build tools and `make`.
+
+## Contributions
+
+Contributions and PRs are welcome.