Custom Roles

Custom Roles

Below is a table of all the current custom roles, followed by a breif description of them. Many of them rely on special abilities also added by this plugin, refer to the list of abilities for more details about what each does. This is default settings and can be customized by the server owner.

RoleName	RoleID	Abilities	Spawn Type	Start Team	Description
Containment Engineer	30	Restricted Escape	Immediately when a round begins	Scientist	A Scientist is randomly selected and is set into Enterance Zone with a Containment Engineer Keycard.
Protocol Enforcer	31	None	Immediately when a round begins	Guard	A lighter facility guard that spawns in light containment zone. They spawn with a Tranquilizer, Medkit, Painkillers, Radio, Light Armor, and a Zone Manager Keycard.
Biochemist	32	Healing Mist, Martyrdom, Custom Role Escape	Immediately when a round begins	Scientist	A Scientist genetically altered.
Containment Guard	33	None	Immediately when a round begins	Guard	A Facility Guard specializing in recontaining SCPs.
Border Patrol	34	None	Given by Admin Command only	Other	A facility guard specialized in ensuring safe passage from Enterance and Heavy Checkpoints.
Nightfall	35	Data Missing	Data Missing	Data Missing	Data Missing.
A7 Chaos	36	None	During a Chaos Insurgency Respawn Wave	Chaos	A Chaos Member that spawns with an A7.
Flipped	37	Scale Ability	Given by Admin Command only	Other	For those people who complains about dwarfs when they spawn in as it.
Telepathic Chaos	38	Detect	During a Chaos Insurgency Respawn Wave	Chaos	A Chaos Member that can detect hostiles to the Chaos Insurgency near by.
Juggernaut Chaos	39	Give Candy Ability	During a Chaos Insurgency Respawn Wave	Chaos	A Chaos Member that specializes in explosives.
Chaos Insurgency Spy	40	Disguised, Remove Disguise	During a MTF Respawn Wave	Ntf	A Chaos Member that is disguised as an MTF Member.
MTF Wisp	41	Effect Enabler	During a MTF Respawn Wave	Ntf	A MTF Member that can go through doors, but has reduced sprint and some item limitations.
Ballistic SCP-049-2	42	Martyrdom	Chance during revive from SCP-049	Scp, Revived	A zombie that goes boom on death.
Dwarf SCP-049-2	43	Scale Ability	Chance during revive from SCP-049	Scp, Revived	A smaller zombie.
Chaos Phantom	44	Active Camo	Immediately when a round begins	Guard	A Chaos Insurgent that takes place of a guard, can go invisible.
Medic SCP-049-2	45	Healing Mist, Effect Enabler	Chance during revive from SCP-049	Scp, Revived	A zombie that can heal other SCPs at the cost of being a bit more slow
Lock-picker Class D	46	Door Picking	Immediately when a round begins	ClassD	A Class D that used to be a lock picker, can open some keycard doors if they dont have the keycard.
MTF Demolitionist	47	None	During a MTF Spawn Wave	Ntf	A MTF Member that specializes in explosives.
Vanguard	48	None	During a MTF Spawn Wave	Ntf	A MTF Member with an alternative loadout, being able to mark a target to do recieve more damage for a short time.
Theoretical Physicist Scientist	49	Pocket Dimension Escape Chance, Custom Role Escape	Immediately when a round begins	Scientist	A Scientist that believes that the Pocket Dimension has a lot more. Has 2 guaranteed escapes from Pocket Dimension to SCP-106's room.
MTF Paramedic	50	Healing Mist, Reviving Mist	Chance during a MTF Spawn Wave	Ntf	A MTF member that specializes in healing teammates.
Class-D Analyst	51	Detect, Custom Role Escape	Immediately when a round begins	ClassD	A Class D that has some analysis abilities.
Class-D Tank	52	Effect Enabler, Scale Ability, Custom Role Escape	Immediately when a round begins	ClassD	A Class-D that can take a bit more punishment than other Class-D.
Infected Zombie	53	Team Convert On Kill	Chance during revive from SCP-049	Scp, Revived	A zombie that can convert targets to a SCP-049-2 when killing a player.
Poisonous Zombie	54	Apply Effect On Hit	Chance during revive from SCP-049	Scp, Revived	A zombie that when attacking a player, will apply the poisoned effect for 10 seconds.
Speedster Zombie	55	Effect Enabler	Chance during revive from SCP-049	Scp, Revived	A zombie that is faster than others.
Husk	56	Apply Husk Infection On Hit	Guaranteed when a player doesn't save themselves from a Husk Infection	Other	When a Husk takes over the body, a random spectator (if the player was alive when the Husk takes over) takes control of the player OR the player (if the player is dead) revives into a Husk.
Teleport Zombie	57	Effect Enabler, Teleport	Chance during revive from SCP-049	Scp, Revived	A zombie that can set a teleport spot, and then teleport to that spot.
Sound Breaker 173	58	Sound Breaker	10% Chance to spawn when SCP-173 spawns.	Scp	A 173 that can reduce the blink interval and range for a short amount of time.
Chaos Replicant	59	Replicator	5% Chance during a CI Spawn Wave	Chaos	A Chaos Insurgent that can make a decoy and control it for a short amount of time.
Dwarf Class D	60	Scale, Infinite Stamina, Restricted Items, Custom Escape	15% Chance at round start.	ClassD	A smaller class D with infinite stamina, but has restricted items and lower health.
Paper Man	61	Scale	Cannot Spawn Naturally	Other	Thin as paper.
Quantum Gravity Researcher	62	None	15% Chance to spawn when a scientist spawns	Scientist	A scientist that specializes in gravity related effects.
Class-D Druggy	63	Addicted	15% Chance to spawn when a class d spawns	Class-D	A Class-D who loves painkillers and adreline
Tesla Techinician	64	Ignore Teslas	15% Chance to spawn when a scientist spawns	Scientist	A scientist who works on tesla gates and knows how to evade them.

Free Custom Roles

Free Custom Roles is a system that allows users to make their own custom roles.

Caution

This is a plugin that depends on VVUP.CustomRoles, it will use the spawning system just like the custom roles provided above. 20 is available out of the box. This is basically unsupported by me, I just wanted to give an option to make custom roles for server owners without much fuss.

Making a free custom role is as best of my ability, easy as possible, below is the default .yml configuration for one.

free_custom_roles1:
- chance: 0
  start_team: Other
  id: 101
  role: None
  max_health: 100
  name: 'Free Custom Role 1'
  description: 'Free Custom Role'
  custom_info: 'Free Custom Role'
  custom_abilities: []
  inventory: []
  ammo: {}
  spawn_properties:
    limit: 0
    dynamic_spawn_points: []
    static_spawn_points: []
    role_spawn_points: []
    room_spawn_points: []
    locker_spawn_points: []
  keep_position_on_spawn: false
  keep_inventory_on_spawn: false
  removal_kills_player: true
  keep_role_on_death: false
  spawn_chance: 0
  ignore_spawn_system: false
  keep_role_on_changing_role: false
  broadcast:
  # The broadcast content
    content: ''
    # The broadcast duration
    duration: 10
    # The broadcast type
    type: Normal
    # Indicates whether the broadcast should be shown
    show: true
  display_custom_item_messages: true
  scale:
    x: 1
    y: 1
    z: 1
  gravity: 
  custom_role_f_f_multiplier: {}
  console_message: 'You have spawned as a custom role!'
  ability_usage: 'Enter ".special" in the console to use your ability. If you have multiple abilities, you can use this command to cycle through them, or specify the one to use with ".special ROLENAME AbilityNum"'

Parameter	Description
Chance	Determines the chance (0-100) of it the role spawning
Start Team	Reference this
Id	The identifier by uint for the custom role. This must be unique per custom role.
Role	This determines the role that the player will be.
Max Health	Determines the max health of the custom role
Name	This is what will be shown TO THE PLAYER when they get the custom role
Description	This is where you should give extra information for the player when they get the custom role
Custom Info	This is what will be shown to other players
Custom Abilities	This will grant custom abilities to the role. Reference this for custom abilities. Adding a custom ability is easy, all you need to do is provide the ability_type, I.E. ability_type: 'RestrictedEscape' to add Restricted Escape, it should populate the config on server restart once you do that to give all other options for Restricted Escape.
Inventory	Gives a list of items that the player will get at when they spawn in. You can include custom items too with their name
Ammo	Gives a list of ammo that the player will get when they spawn in.
Spawn Properties Limit	This determines how many of the custom role can spawn in per round. 0 = None.
Spawn Properties Spawn Points	There's different spawn points that can be used, Dynamic, Static, and Role should be used the most, Static for surface and if you have fixed locations, Dynamic will put you on a side of a door, and Role will use a role spawn point (such as ClassD for Class-D cells). If empty it will use the default spawn location for that role.
Keep Position On Spawn	This will determine if your previous location will be saved when you spawn in as a custom role. Generally you can get away with false but is useful for MTF and CI spawns.
Keep Inventory On Spawn	This will determine if your previous inventory will be saved.
Removal Kills Player	If a player looses a custom role somehow that isnt by in-game death, This will kill them. Best to keep it true.
Keep Role On Death	If a player dies with the custom role, it will keep it if true. Best to keep it false.
Spawn Chance	Unused, Use Chance instead.
Ignore Spawn System	If true, this will not use the spawn system when spawning in. Useful if you want admin or event only custom roles.
Keep Role On Changing Role	If the player swaps role, it will determine if they keep the custom role. Best to leave it false.
Broadcasts	Unused
Display Custom Item Messages	Shows to the player if they pickup or equip a custom item. Best to leave it true.
Scale	Unused, Use Scale Ability instead.
Gravity	Unused, Use Gravity Adjuster instead.
Custom Role Friendly Fire Multiplier	Unused.
Console Message	What it says in the player console when they get a custom role
Ability Usage	What it says in the player console if they get an ability

Custom Roles API

Tip

This plugin has its own system to determine if a custom role can spawn, override the base role. A table of available options is below

Start Team	Enum Value	Description
ClassD	1	For roles that gets a random Class-D player.
Scientist	2	For roles that gets a random Scientist player.
Guard	4	For roles that gets a random Guard player.
Ntf	8	For roles that gets a random NTF/MTF player.
Chaos	16	For roles that gets a random Chaos Insurgent player.
Scp	32	For roles that gets any SCP Player.
Revived	64	For roles that gets a random revived player.
Escape	128	For roles that gets a random player that just escaped.
Other	256	For any other purpose.
Scp049	512	For roles specifically for SCP-049
SCP079	1024	For roles specifically for SCP-079
Scp096	2048	For roles specifically for SCP-096
Scp106	4096	For roles specifically for SCP-106
Scp173	8192	For roles specifically for SCP-173
Scp939	16384	For roles specifically for SCP-939
Scp3114	32768	For roles specifically for SCP-3114

You can combine them, such as a custom zombie having Scp and Revived.

This can be used in other Custom Role plugins as well to quickly setup most custom roles and their spawning methods.

Each SCP has its own start team, so if you make a custom SCP-106 for example, you dont have to worry about a player getting set to a custom SCP-106 while there's also a normal SCP-106 on the field

This is useful for plugin devs using this as a base to make their own custom roles with a start team system, without needing to make their own.

Custom Abilities

Passive Abilities are abilities that runs in the background of the player who has the custom ability, requiring no intervention.

Active Abilities are abilities that requires user input to activate. This is more commonly seen with abilities that has toggles, or something that applies an effect for a set amount of time.

Custom Ability	AbilityName	Ability Type	Description
Ability Remover	AbilityRemover	Passive Ability	Clears abilities, helpful if you have multiple plugins with custom roles and some custom role abilities are given to the wrong custom role.
Active Camo	ActiveCamo	Active Ability	For a set amount of time, allows the player to go invisible unless they fire their weapon, opening/closing doors will reapply the effect.
Addicted	Addicted	Passive Ability	Go for a set amount of time without taking a specific item(s) and the player will experience negative effects.
Apply Effect On Hit	ApplyEffectOnHit	Passive Ability	When a player with this ability attacks another player, it will give them an effect.
Apply Husk Infection On Hit	ApplyHuskInfection	Passive Ability	When a player with this ability attacks another player, it gives them a chance to give them a husk infection.
Custom Role Escape	CustomRoleEscape	Passive Ability	When a player that has this ability tries to escape, you can give them a set role or custom role.
Charge	ChargeAbility	Active Ability	Charges towards a location.
Custom Hume	CustomHume	Passive Ability	Gives a player a custom hume shield (like SCPs)
Detect	Detect	Active Ability	Detects any hostiles of the player's role nearby.
Disguised	Disguised	Passive Ability	This handles all things related to being disguised, such as preventing accidental friendly fire.
Door Picking Ability	DoorPicking	Active Ability	When activated, the player is able to open a door.
Effect Enabler Ability	EffectEnabler	Passive Ability	Handles giving effects to players
Giving Candy Ability	GivingCandyAbility	Passive Ability	Gives candy that's listed at spawn.
Gravity Adjuster	GravityAdjuster	Passive Ability	Adjusts the player's gravity on a per ability basis
Healing Mist	HealingMist	Active Ability	Activates a short term healing AOE effect.
Heal on Kill	HealOnKill	Passive Ability	Heals on kill, hopefully self explainitory on what that does.
Ignore Teslas	IgnoreTeslas	Passive Ability	Disables activating tesla gates and recieving damage from tesla gates.
Infinite Stamina	InfiniteStamina	Passive Ability	Gives the player infinite stamina.
Life Steal	LifeSteal	Passive Ability	When dealing damage, the attacker gains back a % of health.
Martyrdom	Martyrdom	Passive Ability	Explosive death.
Pocket Dimension Escape Chance	PocketDimensionEscapeChance	Passive Ability	Can configure a custom escape chance from the pocket dimension.
Reactive Hume Shield	ReactiveHume	Passive Ability	A Hume Shield that builds up, that reduces incoming damage.
Remove Disguise	RemoveDisguise	Active Ability	The ability to remove their disguise, I.E. If MTF, become CI, and vise versa.
Replicator	Replicator	Active Ability	An ability to spawn a dummy, to decieve players.
Restricted Escape	RestrictedEscape	Passive Ability	This just restricts player escapes for custom roles that has this ability.
Restricted Items	RestrictedItem	Passive Ability	This allows a specific set of restricted items. This is usually complemented with other abilities.
Reviving Mist	RevivingMist	Active Ability	Allows the user to revive other players that recently died.
Scale Ability	ScaleAbility	Passive Ability	This sets a players scale.
Sound Breaker	SoundBreaker	Active Ability	For SCP-173 ONLY, sets the blink cooldown to a low value but also reduces blinks range.
Speed On Kill	SpeedOnKill	Passive Ability	Gives a speed boost on kill.
Team Convert On Kill	TeamConvertOnKill	Passive Ability	When a player kills another, they will be converted to the player's side.
Teleport	Teleport	Active Ability	Toggle the first time to set a teleport spot, then later toggle it again to teleport to the set spot.
Unspectatable	Unspectatable	Passive Ability	Prevents other players from spectating the player that has the ability.