[upcoming] 5.2 Using OTAPI Client Installation
| Contents |
|---|
| 1. Disclaimer |
| 2. Download |
| 3. Known issues |
| 4. Running the launcher |
| 5. Install OTAPI using the Launcher |
| 6. Running Vanilla |
| 7. Running OTAPI / the modded game |
| 8. Preview |
You must already own Terraria for OTAPI to work - we do not host any of base game files, nor do we want to step on relogics toes.
For OTAPI to function it must extract data from the base game for local modifications, and to run the modified game while also maintaining a pristine base game installation.
The Launcher is a cross platform GUI tool to automate the entire process of patching, installing and launching OTAPI in a local installation.
The OTAPI launcher can be downloaded for your specific platform over in the releases section.
Note: Currently only steam and GOG installations are supported out of the box.
- Linux installations do not -easily- work just yet. Some strange issues have cropped up during testing which seem to relate to Roslyn or NLua, however it has been possible to get it running by having no plugins on startup, but later hot loaded/dropped in after launch.
- Install path may need to be persisted
- MacOS permissions - popup for each .dll used. To fix, open
Security & Privacy > Generaland Open / Allow anyway - once launched it should remember until the next update. These files are OTAPI and the .net6 runtimes, you may also review and build every bit of code to confirm. It's also possible to changePrivacy > Developer Tools > Terminalto not prompt for messages, but this is totally not recommended due to the potential security hole.
- Windows - double click OTAPI.Client.Launcher.exe
- Linux - open the terminal and run: ./OTAPI.Client.Laucher
- MacOS - copy the OTAPI.app to your applications folder, and then run normally. you can also cd into the OTAPI.app and run in CLI like linux.
You will then be shown a GUI/window with a install path and a bunch of menu items/buttons, which can be used to install or run the otapi.
After opening the launcher, you will have a button in the menu to install OTAPI. Click it and OTAPI will created locally, and the launcher will download the required files to create and run the new platform.
Once completed you will see "Install complete"...unless however you get unlucky. Due to early stages of development you might come across a big stack trace instead. Feel free to create issues for these, and what system info you failed to launch it on and screenshots of the stack trace (useful ones). However just know I cannot promise I can fix everything.
If enabled, the Launch normal Terraria (vanilla) UI button can be used to launch the regular/untouched game. This may not work if your installation path is not set correctly, however you can still continue to use the regular way you open Terraria from Gog/steam in the past.
To run OTAPI, ensure you have installed it (the UI will try and disable it when OTAPI is not found). Once enabled, the Launch modded Terraria (otapi) button can be used to boot into the modded game. This will load Terraria in the new platform built on .net6, using the launchers installation as it has come preshipped with most of the libraries needed, and the rest were downloaded during patch time.
