Non-Human Races Base

This mod uses Client-Side lua, see the Lua for Barotrauma page for how to install it.

You must enable "C# Scripting" in LuaForBarotrauma's client settings, or else bugs may occur if you have other mods enabled.

Please read the FAQ section if you have any questions.

Configures the game to allow players to select custom non-human characters

The mod loading order

' ExoticRaces being whatever species mods you want

[hr][/hr]

FAQ

Can you add (x) feature to the mod?

The goal of the mod is to have as small of a footprint as possible. Messing with other game mechanics could reduce mod compatibility and will give me more work when they inevitably break.

It's not a flat out no, but I'd rather not.

Why can't I select species when creating a singleplayer game?

LuaForBarotrauma refuses to allow Lua/C# mods to run in the main menu (for good reason!), meaning that the changes to the appearance menu can't run. You'll have to do some cheating/savefile editing to do this, or run the mod in a private multiplayer lobby.

Known Incompatibilities

• Neurotrauma: Doesn't seem to use the IsHuman check

Known Issues

• Trying to join a server that doesn’t have this mod enabled could crash your game
• Certain UI elements won't update correctly
• Mods that alter the default human character currently have broken sprites if they are loaded after (under) NHR. Loading it before NHR will make them appear correctly

[hr][/hr]

For Developers:

This mod is currently very untested, if you run into any issues or technical limitations please let me know

How do I set up my character with this?

Because of technical limitations, this mod requires you to make a Lua file to register your character as a playable species. It's not as hard as you think it will be

Creating the files needed

• Once you've finished creating your character, go into your mod's main folder
• Create a folder named "Lua"
• Create another folder inside of the "Lua" folder named "Autorun"
• Create a new file and change it's file extension to .lua (you can name the file anything, it doesn't matter)

After that, your filepath should look like this:

Registering the species

Now, open the lua file you've created in any text-editing program (really, any!), and paste this code snippet into it.

local NHR = require("tonty.NonHumanRaces")

NHR.RegisterSpecies("species name here")

Here's an example of what it would look like if you had a character with the species name "Lizardperson":

And now you should be done. Starting a new server with all the mods enabled should list the species in your menu

Parameters (advanced case)

Some species may have special behaviour that requires them to be opted out of some NHR features. They can do so using a parameter table as a second argument when registering a species. These are the current parameters:

• uses_default_husk: (bool, true) If the registered species should also opt-in for Human affliction targeting. If false, they will not be able to gain the base game husk afflictions (husk, spineling spines, mudraptor beak). Useful if you have your own implementation.