LuaCsForBarotrauma

Updated for the Summer Update Hotfix v1.13.4.0

Discord: https://discord.gg/f9zvNNuxu9

Consider supporting the project:

https://patreon.com/Evil_Factory

https://github.com/sponsors/evilfactory

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.

[hr]

Installation

There are several different ways to install this mod. Choose whichever method works best for you from the options below.

Only use one installation method at a time. Do not use multiple methods simultaneously.

1 - Launch Option Install Method

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:

[list=1] [*]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: [code]cmd /c "C:\Windows\System32\curl.exe -L -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%"[/code] Linux: [code]bash -c "wget -N https://github.com/Luatrauma/Luatrauma.AutoUpdater/releases/download/latest/Luatrauma.AutoUpdater.linux-x64 && chmod +x Luatrauma.AutoUpdater.linux-x64 && ./Luatrauma.AutoUpdater.linux-x64 %command%"[/code] MacOS: [code]/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"[/code] [*]Close the window and you are done [/list]

Also with this installation method, you don't and shouldn't use the LuaCsForBarotrauma workshop content package, keep the workshop mod disabled.

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.

2 - Classic Install Method

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.

Note: Linux and MacOS are not supported by this installation method.

Every time you host, make sure to enable the LuaCsForBarotrauma package and select the LuaCsForBarotrauma server executable in the hosting menu:

Note that this will only run LuaCsForBarotrauma server-side, to also have the mod installed client-side, do the following instructions:

[list=1] [*]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: [code]install_cl_lua[/code] [*]Restart the game [/list] (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.

3 - Manual Installation Method

This installation method requires you to manually download the mod as a ZIP file from GitHub and extract it into your game directory. Follow the guide below for detailed instructions:

https://evilfactory.github.io/LuaCsForBarotrauma/lua-docs/manual/installing-lua-for-barotrauma-manually

Note: If you are installing this mod on a dedicated server, this is the recommended installation method.

[hr]

Checking if the mod is working properly

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.

Common Troubleshooting

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.

[hr]

Github: https://github.com/evilfactory/LuaCsForBarotrauma/

Lua Documentation: https://evilfactory.github.io/LuaCsForBarotrauma/lua-docs/

Notable Contributors

Perfidious Leaf - Fully reworked and improved the C# loading mechanism peelz - Contributed a lot to the project, from fully reworking the hook system to fixing a bunch of bugs on the moonsharp repo. oiltanker - Contributed the initial CSharp mod loader.