nickpons666/Shiip-of-Hakinian-Espanol
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update references to soh.otr/oot.otr/oot-mq.otr to .o2r (#6161)

Browse Source
This commit is contained in:
Philip Dubé
2026-01-18 16:59:20 +00:00
committed by GitHub
parent 04c5d50b3e
commit c71cc68951
6 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/BUILDING.md
View File

@@ -22,7 +22,7 @@ It is recommended that you install Python and Git standalone, the install proces
_Note: Be sure to either clone with the ``--recursive`` flag or do ``git submodule update --init`` after cloning to pull in the libultraship submodule!_
2. After setup and initial build, use the built-in OTR extraction to make your oot.otr/oot-mq.otr files.
2. After setup and initial build, use the built-in OTR extraction to make your oot.o2r/oot-mq.o2r files.
_Note: Instructions assume using powershell_
```powershell
@@ -34,7 +34,7 @@ cd Shipwright
# Add `-DSUPPRESS_WARNINGS=0` to prevent suppression of warnings from LUS and decomp (src) files. set to 1 to re-enable suppression
& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 17 2022" -T v143 -A x64
# Generate soh.otr
# Generate soh.o2r
& 'C:\Program Files\CMake\bin\cmake.exe' --build .\build\x64 --target GenerateSohOtr
# Compile project
@@ -204,7 +204,7 @@ git submodule update --init
# Add `-DPython3_EXECUTABLE=$(which python3)` if you are using non-standard Python installations such as PyEnv
cmake -H. -Bbuild-cmake -GNinja
# Generate soh.otr
# Generate soh.o2r
cmake --build build-cmake --target GenerateSohOtr
# Compile the project
@@ -261,7 +261,7 @@ brew install sdl2 libpng glew ninja cmake tinyxml2 nlohmann-json libzip
# Add `-DSUPPRESS_WARNINGS=0` to prevent suppression of warnings from LUS and decomp (src) files. set to 1 to re-enable suppression
cmake -H. -Bbuild-cmake -GNinja
# Generate soh.otr
# Generate soh.o2r
cmake --build build-cmake --target GenerateSohOtr
# Compile the project

2
docs/CUSTOM_MUSIC.md
View File

@@ -19,6 +19,6 @@ Once you have prepared your sequences folder:
(*NOTE:* SoH can handle 1024 custom sequence in total. This includes the original music. Keep that in mind!)
1. Click the "Finalize OTR" text in the green footer.
1. Click "Generate OTR" and, using the file selection screen, save the file to the `mods` folder of your SoH installation.
- This `mods` folder should be in the same folder as your `oot.otr` file.
- This `mods` folder should be in the same folder as your `oot.o2r` file.
Assuming you have done everything correctly, boot up SoH and select the SFX Editor from the enhancements dropdown menu. You should now be able to swap out any of the in game sequences/fanfares for the sequences added in your newly generated OTR file. If you have any trouble with this process, please reach out in the support section of the Discord.

2
docs/VERSIONING.md
View File

@@ -1,5 +1,5 @@
## About Versions
The Ship of Harkinian's versioning system is a unique system, comprising of a three-numbered version (`x.y.z`) and a version codename. The main version number `x` signifies major feature updates that require a new `oot.otr` file. The version number `y` signifies major feature updates and bugfixes that do not require a new `oot.otr` file. The version number `z` signifies minor updates such as a collection of bugfixes.
The Ship of Harkinian's versioning system is a unique system, comprising of a three-numbered version (`x.y.z`) and a version codename. The main version number `x` signifies major feature updates that require a new `oot.o2r` file. The version number `y` signifies major feature updates and bugfixes that do not require a new `oot.o2r` file. The version number `z` signifies minor updates such as a collection of bugfixes.
The version codename consists of a sci-fi film character followed by a phonetic alphabet code word. The film character represents a major release version which increments with the major `x` or `y` version bumps. The code word represents a minor release version which increments with the minor `z` version bump.