diff --git a/.gitignore b/.gitignore index 2aca5358..f4c8fb5c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,14 +1,22 @@ __pycache__ +.vscode/c_cpp_properties.json + +# game files +orig/*/* +!orig/SOUE01/README.md +!orig/*/.gitkeep + +# ninja stuff build build.ninja -orig/*/* -!orig/*/.gitkeep -tools/mwcc_compiler/* -!tools/mwcc_compiler/.gitkeep .ninja_deps .ninja_log -objdiff.json -/tools/objdiff.exe -.vscode/c_cpp_properties.json + +# tools tools/dtk +tools/mwcc_compiler/* +!tools/mwcc_compiler/.gitkeep +/tools/objdiff.exe + +objdiff.json ctx.c diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..0e259d42 --- /dev/null +++ b/LICENSE @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.md b/README.md new file mode 100644 index 00000000..32c0ca71 --- /dev/null +++ b/README.md @@ -0,0 +1,104 @@ +# The Legend of Zelda: Skyward Sword + +This repository contains a work-in-progress decompilation of *The Legend of Zelda: Skyward Sword* +for the Nintendo Wii system. + +This repository does **NOT** contain any game assets or assembly. An existing copy of the game is +required in order to contribute. + +Currently, the only supported version of the game is `SOUE01`: the NTSC-U 1.0 version (USA). + +## 🔗 Dependencies + +If the following steps don't work for you, please refer to the +[dtk dependencies documentation](https://github.com/encounter/dtk-template/blob/main/docs/dependencies.md). + +### Windows + +On Windows, it's **highly recommended** to use native tooling. WSL or msys2 are **not** required. +When running under WSL, [objdiff](https://github.com/encounter/objdiff) is unable to get filesystem +notifications for automatic rebuilds. + +- Install [Python](https://www.python.org/downloads/) and add it to `%PATH%`. +- Download [ninja](https://github.com/ninja-build/ninja/releases) and add it to `%PATH%`. + - Quick install via pip: `pip install ninja` + +### macOS + +- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages): + + ```sh + brew install ninja + ``` + +- Install [wine-crossover](https://github.com/Gcenx/homebrew-wine): + + ```sh + brew install --cask --no-quarantine gcenx/wine/wine-crossover + ``` + +After OS upgrades, if macOS complains about `Wine Crossover.app` being unverified, you can +unquarantine it using: + + ```sh + sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app' + ``` + +### Linux + +- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages). +- For non-x86(_64) platforms: Install wine from your package manager. + - For x86(_64), [wibo](https://github.com/decompals/wibo), a minimal 32-bit Windows binary + wrapper, will be automatically downloaded and used. + +## 🔧 Building + +- Clone the repository: + ``` + git clone https://github.com/lepelog/ss-dtk.git + ``` +- Using [Dolphin Emulator](https://dolphin-emu.org/), extract your `SOUE01` game ISO + - Right-click The Legend of Zelda: Skyward Sword game in Dolphin and select `Properties` to open + a new window containing various game properties +![The Legend of Zelda: Skyward Sword is selected in the Dolphin Emulator. The "right-click" context menu has been opened and the "Properties" option is highlighted.](assets/dolphin-game-properties.png) + - Select the `Filesystem` tab at the top of this new window (it should be the rightmost tab) + - Right-click the topmost entry labelled `Disc` and select `Extract Entire Disk` +![The Legend of Zelda: Skyward Sword's properties window in Dolphin with the "Filesystem" tab open. The entry named "Disc" is selected and the "right-click" context menu has been opened with the "Extract Entire Disc..." option highlighted.](assets/dolphin-extract-entire-disc.png) + - Once this has completed, copy the following files into the the `orig/SOUE01` folder of this + project. The rest can be deleted to save space. + - `DATA/sys/main.dol` + - `DATA/files/rels/*.rel` + - `DATA/files/RELS.arc` + - Be sure to place any rels into a `rels` subfolder. See the README.md file in the `orig` folder + for more information. +- Run the configure script: + ``` + python configure.py + ``` +- Build the project with ninja: + ``` + ninja + ``` + +## 🔬 Diffing + +Once the initial build succeeds, an `objdiff.json` should exist in the root of this project. + +Download the latest release of the object diffing tool, `objdiff`, from +[encounter/objdiff](https://github.com/encounter/objdiff). + +Once `objdiff` is opened, set the `Project directory` by clicking on the `Settings` button near the +`Project` heading. + +![The top-right of the "objdiff" program with the "Settings" button highlighted next to the "Project" heading.](assets/objdiff-project-settings.png) + +The project settings window should have opened. At the top of this window, click the `Select` +button next to the `Project directory` heading. + +![The top of the project settings window with the "Select" button highlighted next to the "Project directory" heading.](assets/objdiff-project-directory.png) + +Select the root of this project and `objdiff` should now be fully setup. The configuration should be loaded automatically. + +Select an object from the left sidebar to begin diffing. Changes to the project will rebuild automatically: changes to source files, headers, `configure.py`, `splits.txt` or `symbols.txt`. + +![An example of the "objdiff" program showing the diff of the "d_base" file from this project.](assets/objdiff-example.png) diff --git a/assets/dolphin-extract-entire-disc.png b/assets/dolphin-extract-entire-disc.png new file mode 100644 index 00000000..470a696a Binary files /dev/null and b/assets/dolphin-extract-entire-disc.png differ diff --git a/assets/dolphin-game-properties.png b/assets/dolphin-game-properties.png new file mode 100644 index 00000000..a29a1eba Binary files /dev/null and b/assets/dolphin-game-properties.png differ diff --git a/assets/objdiff-example.png b/assets/objdiff-example.png new file mode 100644 index 00000000..421907c5 Binary files /dev/null and b/assets/objdiff-example.png differ diff --git a/assets/objdiff-project-directory.png b/assets/objdiff-project-directory.png new file mode 100644 index 00000000..9410571f Binary files /dev/null and b/assets/objdiff-project-directory.png differ diff --git a/assets/objdiff-project-settings.png b/assets/objdiff-project-settings.png new file mode 100644 index 00000000..71ea2238 Binary files /dev/null and b/assets/objdiff-project-settings.png differ diff --git a/orig/SOUE01/README.md b/orig/SOUE01/README.md new file mode 100644 index 00000000..02c84934 --- /dev/null +++ b/orig/SOUE01/README.md @@ -0,0 +1,16 @@ +# Necessary files + +In this folder, place the extracted `main.dol` file. Then, create a `rels` folder and place the necessary rels inside. + +Your folder structure should look like this: +``` +├── orig + ├── SOEU01.sha1 + └── SOEU01 + ├── main.dol + ├── README.md + └── rels + ├── d_a_asura_bulletNP.rel + ├── d_a_avater_bulletNP.rel + ├── ... +```