Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xoascf/otrmod

OTR mod generator from ROM images (for Ship of Harkinian)
https://github.com/xoascf/otrmod

blazor blazor-webassembly mod modding soh zelda

Last synced: about 2 months ago
JSON representation

OTR mod generator from ROM images (for Ship of Harkinian)

Awesome Lists containing this project

README 

        
:app: OTRMod

:handle: OTRMod

:desc: The OTR mod tool

:repo: xoascf/{handle}

:!showtitle:

:icons: font

:!toc-title:

:uri-gh: https://github.com

:uri-repo: {uri-gh}/{repo}

:uri-licence: {uri-repo}/blob/master/LICENSE

:uri-ci: {uri-repo}/actions/workflows/build.yml

:uri-shields: https://img.shields.io

:img-licence-badge: {uri-shields}/github/license/{repo}.svg?label=Licence

:img-ci-badge: {uri-shields}/github/actions/workflow/status/{repo}/build.yml?label=Build



= {app}



ifdef::env-github[]

[subs=attributes+]

++++



   
{app}


   
{desc}


   






  

    

  

  

    

  



++++

endif::[]



ifndef::env-github[]



[.text-center]

[.lead]

*{app}*



[.text-center]

{desc}



[.text-center]

image:{img-licence-badge}[Licence, align=center, link="{uri-licence}"]

image:{img-ci-badge}[Build Status (GitHub Actions), align=center, link="{uri-ci}"]

endif::[]



{app} is a versatile tool for creating .otr mods for the PC port of The

Legend of Zelda: Ocarina of Time, known as

https://en.wikipedia.org/wiki/Ship_of_Harkinian[Ship of Harkinian]. It

simplifies the process of creating and exporting features from other N64

ROMs and custom content into SoH.



== Introduction

With its scripting language and really simple web interface, {app}

allows you to create mods that change textures, music sequences, in-game

text and much more, here are some of the features it offers:



* *Scripting Language*: {app} features a scripting language that

enables advanced mod creation and manipulation, allowing you to import

custom sequences, textures, game text, and more from N64 Zelda ROMs.

* *Web Interface*: Access {app} through the web interface at

https://soh.xoas.eu.org[soh.xoas.eu.org] for a user-friendly experience

without downloading the CLI.

* *Command-Line Interface (CLI)*: The CLI provides additional

functionality like .ootrs (Ocarina of Time Randomizer Sequence)

conversion and standalone ROM decompression.



== Usage Examples

* {app} enabled the

https://dorando.emuverse.com/projects/eduardo_a2j/zelda-ocarina-of-time.html[Spanish

translation by eduardo_a2j] for its use in SoH and featured in streams

by Rubius on Twitch (watch his full walkthrough on

https://www.youtube.com/watch?v=XM98fQFQYc8[YouTube]).

* ROMHack translations into Brazilian Portuguese, Italian, Russian, and

other languages have also been ported by the

http://web.archive.org/web/20231219051632if_/https://cdn.discordapp.com/attachments/958069311132536852/1165028159763271690/NTSC_1.0_OTRMod_Bravo.txt[same

script].

* Some non-English-speaking Ocarina of Time fans on

https://discord.com/invite/shipofharkinian[Discord] and beyond have been

enjoying reliving the game in their languages thanks to {app}.



== Planned Features

There are exciting plans for the future of {app}, including:



* Downloadable GUI tool

* Texture conversion from PNG to game format and vice versa

* Custom audio bank/soundfont support

* Explore mod content in the web application

* Modify game scripts completely through the web app editor



Stay tuned for updates!



=== Related Tool: Retro

You might also be interested in exploring another tool created by the

original developers called Retro. Retro allows for HD textures from

PNGs, custom sequences (from the unzipped content of .ootrs), custom

debug menu fonts, and the ability to inspect .otr files. While Retro and

{app} share some common functionalities, they cater to different

aspects of modding. You can find Retro on GitHub at

https://github.com/HarbourMasters64/retro.



*Friendly reminder*:



IMPORTANT: Sharing the generated .otr files is discouraged if they are

created from a ROM or copyrighted file. To ensure legal use of the

generated mods share the script and the corresponding ROM hashes.



NOTE: Don’t forget to visit the

https://gamebanana.com/games/16121[GameBanana] page to download really

nice .otr mods!



Feel free to explore these modding tools and enhance your Ship of

Harkinian experience!