Barotrauma

Barotrauma

45 ratings
Lua For Barotrauma - A Guide to Clientside Lua
By Tonic
An illustrated guide to demonstrate how to (un)install Clientside Lua for the Lua For Barotrauma mod.
3
   
Award
Favorite
Favorited
Unfavorite
Why do you need Clientside Lua?


Clientside Lua is an additional mod that opens greater potential to modmakers outside of XML files by implementing support for the Lua programming language[en.wikipedia.org]

• Various mods such as BetterHealthUI and Performance Fix work as Clientside additions which means you can use them between servers without the host needing them installed!

• Other mods such as Movable and Sellable Wrecks require both Serverside Lua (hosting with the Lua For Barotrauma - DedicatedServer server executable) and Clientside Lua in order to function stably and to mitigate desync problems.
Enabling Lua For Barotrauma
First, to install Clientside Lua, you must have the addon downloaded and enabled in the mods tab on the main menu.


Once you have downloaded the mod:

• Refresh your mods tab and you will see Lua for Barotrauma, you may need to close and reopen the mods tab for it to show up after installing.

• Drag it from your disabled packages list on the right-hand side to your enabled packages list on the left-hand side

• It is advised to disable all other content packages to make the next section quicker.

• Finally, press the apply button to save your changes and enable the mod.

Hosting a Server
Next, you will need to host a server in order to install Clientside Lua.

• On the main menu, select Host Server.

• A new drop-down box will be visible underneath the password box called Server Executable. Select the drop-down and change it from Vanilla to Lua For Barotrauma - DedicatedServer.

• All other parameters of the server do not matter, but it is advised that you uncheck the public server setting so your server does not appear on the browser while installing.

• Press the Start button to begin hosting your server, this will take longer to load than the Vanilla executable and depends on your hardware as well as other enabled packages which will increase loading time depending on their size.

Using the Console
After loading into a server, you will need to run a command in your console to install Clientside Lua.

• In the server lobby, you will want to open your console. The default keybind for opening console is F3.

• Once the console box opens on the top left, click on the dialogue box and type install_cl_lua and then press enter.

• A pop-up will appear in the middle of your screen telling you that Clientside Lua has been successfully installed and that you must restart your game for any changes to take effect.

Ensuring Clientside Lua is Enabled
This is an additional step to make sure your Clientside Lua is enabled.

• Restart your Barotrauma if you have not done it in the previous section.

• On the main menu, you will see a red strip of text in the top left of your screen that should read something along the lines of:
Using LuaCsForBarotrauma revision [X] version [X]

• This can be used to keep track of what version of Clientside Lua you are using, it is recommended to overwrite your install by following the guide from the start to ensure you have the latest version.

Uninstalling/Tweaking Clientside Lua
If you ever need to remove your Clientside Lua install or want to access its options, you can follow the steps below.

• Underneath the red strip of text indicating your install revision and version, click on the button reading:
Open LuaCs Settings

• You will see a list of settings, as well as a button reading:
Remove Client-Side LuaCs

• After confirming the uninstall, you may restart your game to clear it of any residual files from the mod.

12 Comments
Pawsy 12 Jul @ 10:32am 
hey uh the mod just fucked my game i tried deleting it from mods folder but didnt do a shit i cant open the game it wont do anything i tried spamming it with autoclicker it didnt do anything how do i remove it :(
Discombobulating 13 Aug, 2024 @ 2:35pm 
Thank you!
Tonic  [author] 1 Jul, 2024 @ 7:45am 
have you restarted after removing it in the settings menu?
if not, try verifying your game files as well
яйца горят 30 Jun, 2024 @ 9:53pm 
lua dont removed, help
okayeg 26 Apr, 2024 @ 9:43am 
Incase anyone doesn’t know, you have to do this every time the game is updated.
Hiro Baker 16 Mar, 2023 @ 4:24pm 
I did and was able to figure it out. Thank you
Tonic  [author] 16 Mar, 2023 @ 12:23pm 
i've never personally had this issue, but i would recommend talking to the creator of the mod, Evil Factory for help!
Hiro Baker 16 Mar, 2023 @ 11:41am 
Hello, can I get some help? It keeps saying "The Server Process has shut down unexpectedly."
Rednov 16 Mar, 2023 @ 10:08am 
my dick quivered upon reading, thank you
KASPA 8 Mar, 2023 @ 10:06am 
Thank you man