Improved manual install docs
This commit is contained in:
EvilFactory
@@ -1,47 +1,30 @@
|
||||
# Installing Lua For Barotrauma Manually
|
||||
# Installing LuaCs For Barotrauma Manually
|
||||
|
||||
**Notice**: the "Lua For Barotrauma" content package is not required if installed manually, but you may use it anyway if you wish to support the mod, since players automatically download packages when joining the server.
|
||||
The manual installation of the mod involves the simple task of just replacing some files in your game files, so lets get into how to do that.
|
||||
|
||||
If you get TextManager errors, open `config_player.xml` in your server folder and change the language from "None" to "English"
|
||||
## Server patch vs Client patch
|
||||
The client patch is for when when you need to install client-side support, this will provide your game with singleplayer support and some other mods that require client-side to be installed to work in multiplayer.
|
||||
The server patch will replace your Vanilla executable (the one you use by default when hosting) with the LuaCs one, this allows you to host servers with LuaCs without having the LuaCsForBarotrauma content package enabled.
|
||||
The two patches can both be used at same time, for when you need both client-side and server-side in your game.
|
||||
|
||||
## How to apply a patch to my game files/my dedicated server
|
||||
First you need to download the correct patch that corresponds to your platform, head over to `https://github.com/evilfactory/LuaCsForBarotrauma/releases/tag/latest` and choose which patch you want to install. For example, if i want to install both client-side and server-side on my windows machine, i'll download both `luacsforbarotrauma_patch_windows_server.zip` and `luacsforbarotrauma_patch_windows_client.zip`.
|
||||
|
||||
After downloading the patch file(s) that you want to use, you will need to now find where your game files are located you can do that by:
|
||||
1. Going to your steam library
|
||||
2. Right clicking Barotrauma
|
||||
3. Clicking Manage -> Browse Local Files
|
||||
4. Your file explorer should open with where your game files are located.
|
||||
5. (MacOS) When going to the game files in MacOS, you will probably notice you aren't in the actual game files, you have to right click the Barotrauma application, and click "Show Package Contents", then navigate to Contents -> MacOS, this is where you will put the patch files.
|
||||
|
||||
Now, all you have to do is extract the patch files you downloaded, and paste their files into your game files folder (or in case of dedicated servers, where your server is installed), this should prompt you to replace a bunch of .dll files.
|
||||
After that, it's done, you can test if it was successfully installed by testing the debug console (F3) commands: `cl_reloadluacs` (for client-side) or `reloadluacs` (for server-side, you need to be hosting a server)
|
||||
|
||||
If you are confused, there's this video showing how to install client-side manually on Windows:
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/1T0srKPp5BI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
|
||||
## Adding to an existing server
|
||||
|
||||
1. Download [the latest server patch](https://github.com/evilfactory/LuaCsForBarotrauma/releases/tag/latest) (make sure to download the "patch" zip for your platform, e.g. `luacsforbarotrauma_patch_windows_server.zip`)
|
||||
## Builds
|
||||
|
||||
2. Extract the zip archive into your existing server folder and replace files as necessary
|
||||
|
||||
## Adding to an existing client
|
||||
|
||||
1. Download [the latest client patch](https://github.com/evilfactory/LuaCsForBarotrauma/releases/tag/latest) (make sure to download the "patch" zip for your platform, e.g. `luacsforbarotrauma_patch_windows_client.zip`)
|
||||
|
||||
2. Extract the zip archive into your game folder and replace files as necessary
|
||||
|
||||
|
||||
## Installing from scratch
|
||||
|
||||
1. Download [the latest build](https://github.com/evilfactory/LuaCsForBarotrauma/releases/tag/latest) (make sure to download the "build" zip for your platform, e.g `luacsforbarotrauma_build_windows.zip`)
|
||||
2. Extract the zip file
|
||||
3. Find the Content folder in your original Barotrauma game:<br/>
|
||||
<img src="https://cdn.discordapp.com/attachments/799752463619325968/833120013149929492/unknown.png" width="500" /><br/>
|
||||
<img src="https://cdn.discordapp.com/attachments/799752463619325968/833120379378991104/unknown.png" width="500" /><br/>
|
||||
<img src="https://cdn.discordapp.com/attachments/799752463619325968/833120841277374464/unknown.png" width="500" />
|
||||
4. Copy the Content folder to the extracted folder:<br/>
|
||||
<img src="https://cdn.discordapp.com/attachments/799752463619325968/833133217300742154/unknown.png" width="500" />
|
||||
6. **Optional**: Copy `config_player.xml` from your original game so it retains your configurations
|
||||
7. Done! Now run DedicatedServer.exe to run the modded server or run Barotrauma.exe to run the modded client
|
||||
|
||||
### Linux notice
|
||||
|
||||
Sometimes you will get steam initialization errors, most of the time it's because it's missing the `linux64/steamclient.so` binary, so you can just copy the binary from your steam installation over to the folder and it should work.
|
||||
|
||||
### Mac Notice
|
||||
|
||||
The installing from scratch installation has a few issues for this specific operating system, it's recommended to do the adding to an existing server/client instead, but if you want to do it anyway, you might need to:
|
||||
- Copy steamclient.dylib located at /Users/YourUsername/Library/Application Support/Steam/Steam.AppBundle/Steam/Contents/MacOS* to the extracted folder
|
||||
- Create a file called steam_appid.txt with the content 255710 inside the extracted folder.*
|
||||
|
||||
## Checking if everything is working
|
||||
|
||||
If the commands `reloadlua` or `cl_reloadlua` work without errors, it means you successfully installed the mod.
|
||||
Builds are full builds of Barotrama without the Content folder, those generally are not recommended unless you know what you are doing, but all you have to do to get them working is download the one that matches your platform, and copy the original Content folder from your game to the folder where you extract your build, then you just need to run the game executable.
|
||||
Reference in New Issue
Block a user