Subscribe to download
Lua For Barotrauma

This is a Barotrauma modification that adds Lua modding, and optional CSharp modding, this is not a direct replacement for xml, but works great in doing things that weren't possible in xml.

---

Client-side mods run on your game client, whether you're playing singleplayer or joining a server. Server-side mods run on the server, which applies when you're hosting, meaning both client and server mods are active.

It's important to know that some mods require only server-side, some only client-side, and some both. If you don't have the necessary client-side mod, some features might be disabled, or the mod might not work properly. For example, Neurotrauma works in multiplayer with only server-side installed, but you'll need client-side for singleplayer. Meanwhile, Movable and Sellable Wrecks requires both server-side and client-side for multiplayer; players without the client-side mod may encounter issues.
So always consult the mod description to know what it exactly requires.

---

There's two parts to this mod, the server-side and the client-side, which one you need depends on the mod that you are trying to use. Client-side is always required for singleplayer support.

The mod now has a new installation method, you can install it by simply putting in a special launch option in Steam, here's how you do it:

• Make sure your game is closed
  
• Go to your Steam Library
  
• Right Click Barotrauma and Click Properties
  
• You should be able to see the Launch Options and below it a text box that you can enter text into
  
• Enter the following code into the text box:
  Windows:
  cmd /c "curl -L -z Luatrauma.AutoUpdater.win-x64.exe -o Luatrauma.AutoUpdater.win-x64.exe https://github.com/Luatrauma/Luatrauma.AutoUpdater/releases/download/latest/Luatrauma.AutoUpdater.win-x64.exe && start /b Luatrauma.AutoUpdater.win-x64.exe %COMMAND%"
  Linux:
  bash -c "wget https://github.com/Luatrauma/Luatrauma.AutoUpdater/releases/download/latest/Luatrauma.AutoUpdater.linux-x64 && chmod +x Luatrauma.AutoUpdater.linux-x64 && ./Luatrauma.AutoUpdater.linux-x64 %command%"
  MacOS:
  /bin/zsh -c "cd Barotrauma.app/Contents/MacOS && /usr/bin/curl -LOR https://github.com/Luatrauma/Luatrauma.AutoUpdater/releases/download/latest/Luatrauma.AutoUpdater.osx-x64 && chmod +x Luatrauma.AutoUpdater.osx-x64 && ./Luatrauma.AutoUpdater.osx-x64 %command%/Contents/MacOS/Barotrauma"
• Close the window and you are done

This installation method will download the mod and install automatically both client-side and server-side from GitHub every time you launch the game. This means the mod installation will always be preserved even if you verify the game files or a new Barotrauma update is released. You can of course uninstall the mod by deleting the launch option and verifying the game files.

Also with this installation method, you don't and shouldn't use the content package, you can enable it if you want to, but it's not required, just make sure to NOT select LuaForBarotrauma in the ServerExecutable dropdown if you are hosting a server.

This is the classic way of installing the mod, it makes use of the content package, so make sure to have this mod subscribed and updated in the workshop.

If you are running Linux, subscribe/enable Lua For Barotrauma Linux instead.

If you are using MacOS, this installation method is not supported, you will need to install the mod manually, refer to this guide: https://evilfactory.github.io/LuaCsForBarotrauma/lua-docs/manual/installing-lua-for-barotrauma-manually

There's two parts to this installation, server-side and the client-side, which one you need depends on the mod that you are trying to use. Client-side is always required for singleplayer support.

Server-Side
Simply enable the mod and before hosting a server, select LuaForBarotrauma in the ServerExecutable dropdown. This is all you need to do to enable the mod server-side.



Client-Side
This one is a bit more complicated, you need to install the mod while hosting a server, here's how you do it:

• Open hosting menu
  
• Select LuaForBarotrauma in ServerExecutable and host a server
  
• While hosting, open the console window (most commonly 'F3')
  
• Type in or copy, then execute the console command:
  install_cl_lua
• Restart the game

(Video if you don't understand the instructions above: https://www.youtube.com/watch?v=wEeJ70vH1TM )

The client-side installation will be reverted every time you verify the game files or a new Barotrauma update is released, so you will need to do this process again if that happens.

Dedicated servers require you to manually install the mod, refer to this guide:
https://evilfactory.github.io/LuaCsForBarotrauma/lua-docs/manual/installing-lua-for-barotrauma-manually
Note: Some game hosting services don't allow you to mess with the game files, so you might not be able to install the mod on those services.

---

You can test if client-side is working properly by opening the debug console (F3) and typing in cl_reloadluacs, if you see a message saying command not found, then the mod is not installed on the client.
To test if server-side is working, first host a server, then open the debug console (F3) and type in reloadluacs, again if you see a message saying command not found, then the mod is not installed on the server.

If you are having problems with the mod, always try doing these things before seeking for help:

- Go to the Barotrauma in game workshop menu, and click the reinstall button

- Delete this folder %LocalAppData%\Daedalic Entertainment GmbH\Barotrauma\WorkshopMods\Installed\2559634234 and restart the game

- Disable and Enable the mod and try again

Nothing worked? Feel free to seek for help, but please always try to provide as much information as possible, it's hard to solve a problem without much information.

---

Perfidious Leaf[github.com] - Fully reworked and improved the C# loading mechanism
peelz[github.com] - Contributed a lot to the project, from fully reworking the hook system to fixing a bunch of bugs on the moonsharp repo.
oiltanker[github.com] - Contributed the initial CSharp mod loader.
zhurengong[github.com] - Provided lots of useful feedback for the mod on the early days and helped with the making of the CSharp loader.

Special thanks to all sponsors that kept and keep the project going:
Taj the King
FearTheQueer[github.com]
Ricky[github.com]
Rolf Lewis[github.com]
Perfidious Leaf[github.com]
Hadrada[github.com]
WjunniorW
dnova
Amadare
Esirprus
The Great Coachwhip
Evergreen
StarryCult