Configuration elements
Last updated
Last updated
Here the main configuration elements will be explained. You need to read the whole page in order to create basic Custom Roles with UCR. We'll always reference to the main YAML configuration given at the part of this wiki.
Configuration element name: id
Type: int32
The unique Identifier for your Custom Role. You'll have to use this in order to spawn a player as that role and to get information about that role. Identifiers must be unique so watch out to avoid using the same Id for multiple roles: only the first one will be loaded!
Configuration element name: name
Type: string
The name of the Custom Role. This value is visible only to the server owner (unless is activated) and it can be a simpler way to identify a role. If is activated then this string will appear also to the other players instead of the vanilla role name.
Configuration element name: override_role_name
Type: bool
Whether the should appear inside the player info area (to other players) instead of the vanilla role name.
Configuration element name: nickname
Type: string
This configuration value is nullable and if null no operations will be done on the player's nickname.
The nickname that will be assigned to the player when they'll be this Custom Role.
You can put different nicknames by splitting them with a comma (,): if there are multiple nicknames the plugin will randomly choose between one of them.
That function supports also Placeholders(R).
Configuration element name: custom_info
Type: string
This configuration value is nullable and if null nothing will be set as the player's custom info.
The custom info that will be assigned to the player when they'll be this Custom Role. Custom info appears just under the role name and it's visible only to other players.
Configuration element name: badge_name
Type: string
This configuration value is nullable and if null no operations no badge will be added to the player.
The temporary Badge that will be added to the player when they'll be this Custom Role. Badges are visible both to the player and to other players in the custom info area (it will be the first element) and in the player list.
Configuration element name: badge_name
Type: string*
This configuration value is nullable and if null no operations no badge will be added to the player
The wanted RoleTypeId for the Custom Role.
The custom team for a Custom Role.
You can create, for example, a ClassD that's an SCPs or things like that to make the game more interesting.
With Is Friend Of you can decide which teams can harm (and can be harmed) by this Custom Role.
For example, if the Custom Role's role is ClassD and is friend of is
the Custom Role won't be able to damage Scientists (nor them will be able to harm the Custom Role).
Note: this is just an ADDITION to the game main logic!
Configuration element name: max_scp330_candies
Type: int32
Indicates the maximum number of candies that can be taken from SCP-330 without having your hands severed.
Configuration element name: can_escape
Type: bool
Configuration element name: scale
Type: Vector3
A simple Vector3 that decide the scale on the three dimensions (X, Y and Z).
It's an object with three keys (x, y and z) and three int32 as values.
Example:
Configuration element name: spawn_broadcast
Type: string
The spawn broadcast that gets displayed to the user when they spawn as the Custom Role. Here you can use the Unity syntax to decide the text's size, color, weight and everything else.
Configuration element name: spawn_broadcast_duration
Type: ushort
The duration of the spawn broadcast in seconds.
Configuration element name: spawn_hint
Type: string
The spawn hint that gets displayed to the user when they spawn as the Custom Role. Here you can use the Unity syntax to decide the text's size, color, weight and everything else.
Configuration element name: spawn_hint_duration
Type: float
The duration of the spawn hint in seconds.
A simple Dictionary that allow server owners to edit the default inventory limits value for each Custom Role. For example Class-D have a limit of 3 firearms: with this configuration parameter you can increase or even decrease this value! Note: if an ItemCategory is not specified the plugin will use it's default value!
Example:
(Yeah now you can have up to 5 grenades but only 1 firearm)
Customizing the inventory of a Custom Role might be the most important thing to do and UCR gives you a simple -but powerful- tool to achieve that. The Inventory configuration value is a simple list of ItemTypes: every item will be added to the player's inventory.
Example:
Configuration element name: custom_items_inventory
Type: []int32
UCR does support both EXILED CustomItems and UncomplicatedCustomItems (UCI) and with this configuration parameter you can add Custom Items from both plugins to your Custom Role. Just put the Custom Item's Id and it will be given! Note: remember to NOT have Id conflicts between EXILED CI and UCI as if you have two items with the same Id UCR will always take the UCI one!
Example:
You can also customize the amount of ammo that a Custom Roles has. Note: the plugin actually overrides the default amount of ammo: for that reason if you don't give ammo to a Custom Role it won't have any of them!
Configuration element name: damage_multiplier
Type: float
The damage multiplier that will be applied to the damage dealt by this role to another player. We use the following formula:
For that reason if the value is 1 then nothing will change while if we set the value for example to 1.5 and we deal 20HP the given damage will be 30HP.
The SpawnSettings configuration parameter has its own object as it's a main part of the configuration and because of its complexity another page is needed for a better organization. Please visit this page in order to read more about the Spawn Settings param.
Configuration element name: ignore_spawn_system
Type: bool
If true the Custom Role won't be evaluated by our Spawn System but you'll be able to spawn it manually using commands!
You can choose a color for the badge by editing
The Badge color. Note: you can use a limited number of colors marked as "Server groups" inside the !
Configuration element name: role
Type:
This configuration value is an Enum: please visit the page in order to learn more about them!
Configuration element name: team
Type:
This configuration value is nullable and if null the player will have the default team of the choosen .
This configuration value is an Enum: please visit the page in order to learn more about them!
Configuration element name: role_appearance
Type:
This configuration value is nullable and if null the player will have the default appearance of the choosen .
This configuration value is an Enum: please visit the page in order to learn more about them!
If not null the player will be the given but every other player will see him as the given Role Appearance role.
Configuration element name: is_friend_of
Type:
This configuration value contains Enum values: please visit the page in order to learn more about them!
The Health configuration parameter has its own object with its own specifications. Please visit in order to read how to configure it.
The AHP configuration parameter has its own object with its own specifications. Please visit in order to read how to configure it.
The Hume Shield configuration parameter has its own object with its own specifications. Please visit in order to read how to configure it.
The Effects configuration parameter has its own object with its own specifications. Please visit in order to read how to configure it.
The Stamina configuration parameter has its own object with its own specifications. Please visit in order to read how to configure it.
Indicates whether the Custom Role can escape or not (through the exit on the Surface). The behavior behind the escape event is decided by editing the configuration parameter.
The Role After Escape configuration parameter has a complex syntax in order to allow server-owners to have a more advanced and complete configuration method to customize escape logic for each Custom Role. Please visit in order to learn the syntax and read how to correctly use it.
You can choose the duration through the configuration value.
You can choose the duration through the configuration value.
Configuration element name: custom_inventory_limits
Type: , sbyte
This configuration value contains Enum values: please visit the page in order to learn more about them!
Configuration element name: inventory
Type:
This configuration value contains Enum values: please visit the page in order to learn more about them!
Configuration element name: ammo
Type:
This configuration value contains Enum values: please visit the page in order to learn more about them!
With the v6.0.0 Custom Flags officially became open to the developers and because of that the system changed in a more customizable -but complex- one.
The explanation (with the list of built-in Custom Flags) is available at .