Skill Tree 1.1.26

 

 

This plugin adds a character progression system to your server in the form of a leveling and skill tree system.

Players gain xp by cutting trees, mining rocks, killing NPCs etc, and are rewarded with skill points when they level up. 

These points can be used to unlock perks and buffs across a number of different skill trees.

The plugin is extremely customizable and server owners can change, move, scale or disable any perk to tailor the setup to their server.

It features:

• 62 unique buff types.
• 10 unique skill trees.
• 47 sources of xp with configurable values.
• A functional tree system that prevents unlocking/upgrading of nodes if the player has not invested enough skill points into a tree.
• Configurable limits on the amount of skill points that players can spend, allowing for more specialized builds.
• Capable of building your own additional trees and nodes.

SkillTree allows users to focus on multiple skill trees and unlock nodes in each tree as they level, to make their characters more powerful and unique.

 

skilltree.chat 	- required to use the chat commands to access the skill tree menu.
skilltree.xp 	- required to obtain xp from xp sources.
skilltree.tree 	- required to access and use the skill tree.
skilltree.admin - required to use the admin commands.
skilltree.all - allows user access to all trees.
skilltree.Mining - allows the user to access the mining tree.
skilltree.Woodcutting - allows the user to access the woodcutting tree.
skilltree.Skinning - allows the user to access the skinning tree.
skilltree.Harvesting - allows the user to access the harvesting tree.
skilltree.Combat - allows the user to access the combat tree.
skilltree.Medical - allows the user to access the medical tree.
skilltree.Build_Craft - allows the user to access the build craft tree.
skilltree.Scavenging - allows the user to access the scavenging tree.
skilltree.Vehicles - allows the user to access the vehicles tree.
skilltree.Cooking - allows the user to access the cooking tree.
skilltree.bag.keepondeath - prevents the ExtraPockets bag from dropping on death.
skilltree.notitles - Removes the level title from the player (Requires BetterChat)

//Custom permission settings

"Modified max skill points based on permissions [must be higher than default]": {
    "vip": 120
},

"Cost per point to respec based on permissions [must be lower than default]": {
    "vip": 10.0
},

"Maximum amount of xp a player can lose when they die based on permissions [must be less than default]": {
    "vip": 500.0
},

"Permissions to adjust xp gain modifiers (skilltree.<perm>) [1.0 is default modifier]": {
    "vip": 1.2
},
    
The permission for "vip" would be skilltree.vip
Assigning this perm to players would override the default values for the respective settings (max skill points, respec cost, xp gain and xp loss).

 

Command: st
Description: Opens the skill tree menu. Requires skilltree.chat permissions.

Command: xp
Description: Displays the current xp and level information for the user.

Command: updatexptable
Description: Recalculates the xp table based on the config values. Requires 

Command: togglexpdrops
Description: Toggles the xp popup when obtaining xp.

Command: togglexphud
Description: Toggles the xp hud on the players screen.

Command: givexp
Parameters: <name> <amount>
Description: Gives the player matching the name parameter, xp equal to the amount parameter.

Command: givesp
Parameters: <name> <amount>
Description: Gives the player matching the name parameter, skill points equal to the amount parameter.

Command: resetdata
Parameters: <name>
Description: Resets the target players data.

Command: turbo
Description: Toggles the turbo on the boat if the player has the relevant perk.

Command: togglebc
Description: Toggles the BetterChat title on/off for the user.

Command: movebar
Description: brings up a ui that can be used to relocate the xp bar on the players screen.

Command: stresetalldata
Description: Resets all players data.

Command: stresetskills
Description: Refunds all players skill points

Command: sb or score or scoreboard
Description: Chat and console command that brings up the scoreboard, showing who has the most xp.

Command: sttogglenotifications
Description: Toggle notifications from buff triggers.

 

Experience can be gained from a number of different sources. The value for each source can be adjusted via the config.

NodeHit - Hitting a stone, metal or sulfur mining node.
NodeHitFinal - Finishing a stone, metal or sulfur mining node.
TreeHit - Hitting a tree.
TreeHitFinal - Knocking down a tree.
SkinHit - Hitting an animal with a skinning tool.
SkinHitFinal - Finishing off an animal with a skinning tool.
CollectWildPlant - Collecting any map generated collectible, such as hemp, corn, pumpkin, stone, sulfur or metal.
CollectGrownPlant - Collecting any player grown produce.
BuildingBlockDeployed - Placing down a twig building block.
FishCaught - Catching a fish.
Crafting - Whenever a craft is successfully completed. XP is calculated based on the duration of the craft.
ScientistNormal - Killing a blue scientist.
ScientistHeavy - Killing a heavy scientists.
SmallAnimal - Killing a small animal such as a chicken.
MediumAnimal - Killing a medium animal such as a boar, wolf or stag.
LargeAnimal - Killing a large animal such as a horse, shark or bear.
Barrel - Destroying barrels.
RoadSign - Destroying road signs.
Scarecrow - Killing scarecrows or a zombie in ZombieHorde.
Mission - Completing a mission in rust.
BradleyAPC - Getting the last hit on Bradley.
LootHackedCrate - First player to loot a locked crate.
LootHeliCrate - First player to loot a heli crate.
LootBradleyCrate - First player to loot a bradley crate.
CookingMealXP - (Requires cooking plugin) XP is calculated per ingredient used. Example 2 tomatos and 8 bear meat would yield 100xp.
RaidableBaseCompletion - Awards raiders of a RaidableBase xp upon the completion of the raid.
Win_HungerGames - Awards xp to the winner of the Hunger Games arena.
Win_ScubaArena - Awards xp to the winner of the Scuba arena.
Win_Skirmish - Awards xp to the winner of the Skirmish arena.
Gut_Fish - Awards xp when gutting a fish.
default_botrespawn - default amount xp given when killing a bot made using botrespawn. Overriding values can be added to the config based on the bot group.
crate_basic - when opening crates
crate_elite - when opening crates
crate_mine - when opening crates
crate_normal - when opening crates
carte_normal_2 - when opening crates
crate_normal_2_food - when opening crates
crate_normal_2_medical - when opening crates
crate_tools - when opening crates
crate_underwater_advanced - when opening crates
crate_underwater_basic - when opening crates
crate_ammunition - when opening crates
crate_food_1 - when opening crates
crate_food_2 - when opening crates
crate_fuel - when opening crates
crate_medical - when opening crates

 

Name: Mining Yield
Config Value: 1
Description: Increases the amount of resources gained while mining.

Name: Instant Mine
Config Value: 2
Description: Gives the user a chance to instantly mine out a stone, sulfur or metal node.

Name: Smelt On Mine
Config Value: 3
Description: Gives the user a chance to smelt some of the ore as its mined from sulfur and metal nodes.

Name: Mining Luck
Config Value: 4
Description: Gives the user a chance to obtain items from the Mining luck loot table when they finish mining a node.

Name: Mining Tool Durability
Config Value: 5
Description: Decreses the durability loss of mining tools.

Name: Woodcutting Yield
Config Value: 6
Description: Increases the amount of resources gained while woodcutting.

Name: Instant Chop
Config Value: 7
Description: Gives the user a chance to instantly chop down a tree.

Name: Woodcutting Coal
Config Value: 8
Description: Gives the user a chance to obtain some charcoal while woodcutting.

Name: Woodcutting Luck
Config Value: 9
Description: Gives the user a chance to obtain items from the Woodcutting luck loot table when they finish cutting down a tree.

Name: Woodcutting Tool Durability
Config Value: 10
Description: Decreses the durability loss of woodcutting tools.

Name: Skinning Yield
Config Value: 11
Description: Increases the amount of resources gained while skinning.

Name: Instant Skin
Config Value: 12
Description: Gives the user a chance to instantly cut up an animal.

Name: Skinning Tool Durability
Config Value: 13
Description: Decreases the durability loss of skinning tools.

Name: Skinning Cook
Config Value: 14
Description: Gives the user a chance to received cooked meat, instead of raw meat, while skinning an animal.

Name: Harvest Wild Yield
Config Value: 15
Description: Increases the yield when harvesting map generated collectibles, such as berries, hemp, stone, sulfur and mushrooms.

Name: Harvest Grown Yield
Config Value: 16
Description: Increases the yield when harvesting player grown produce.

Name: Extra Fish
Config Value: 17
Description: Gives the user a chance of receiving an extra fish while fishing.

Name: Double Bandage Heal
Config Value: 18
Description: Doubles the healing power of cloth bandages.

Name: Radiation Reduction
Config Value: 19
Description: Reduces the amount of radiation damage taken by the player.

Name: Extra Food
Config Value: 20
Description: Increases the amount of calories the player receives when consuming food.

Name: Fire Damage Reduction
Config Value: 21
Description: Reduces the amount of fire damage received.

Name: Fall Damage Reduction
Config Value: 22
Description: Reduces the amount of fall damage received.

Name: No Cold Damage
Config Value: 23
Description: Removes all cold damage from the player.

Name: Wounded Resist
Config Value: 24
Description: Gives the player a chance to get straight back on their feet after entering the wounded state.

Name: Animal Damage Resist
Config Value: 25
Description: Reduces the damage taken by animals.

Name: Riding Speed
Config Value: 26
Description: Increases the speed of a horse while riding it.

Name: Free Bullet Chance
Config Value: 27
Description: Gives the player a chance to not expend a bullet when firing a gun.

Name: Primitive Expert
Config Value: 28
Description: Removes durability loss for primitive weapons.

Name: Upgrade Refund
Config Value: 29
Description: Gives the player a chance to receive their resources back when upgrading a building block.

Name: Craft Speed
Config Value: 30
Description: Increases the crafting speed of a player.

Name: Research Refund
Config Value: 31
Description: Gives the player a chance to receive their scrap back when researching an item on the research bench.

Name: Craft Refund
Config Value: 32
Description: Gives the player a chance to receive their crafting materials back when crafting an item.

Name: Extra Scrap Barrel
Config Value: 33
Description: Gives the player a chance to receive additional scrap when destroying a barrel.

Name: Barrel Smasher
Config Value: 34
Description: Allows the player to instantly smash a barrel with any weapon.

Name: Extra Scrap Crate
Config Value: 35
Description: Gives the player a chance to obtain extra scrap when looting a crate for the first time.

Name: Component Chest
Config Value: 36
Description: Gives the player a chance to obtain additional components when looting a crate for the first time.

Name: Electronic Chest
Config Value: 37
Description: Gives the player a chance to obtain additional electronics when looting a crate for the first time.

Name: Component Barrel
Config Value: 38
Description: Gives the player a chance to obtain additional components when smashing a barrel.

Name: Electronic Barrel
Config Value: 39
Description: Gives the player a chance to obtain additional electronics when smashing a barrel.

Name: Melee Resist
Config Value: 40
Description: Reduces the damage taken by melee weapons.

Name: Iron Stomach
Config Value: 41
Description: Allows the player to eat spoiled and raw food without being poisoned.

Name: Boat Speed
Config Value: 42
Description: Allows the user to activate a turbo boost while on a boat, increasing the boats speed.

Name: Recycler Speed
Config Value: 43
Description: Increases the speed of recycling for the player.

Name: Recycler_Speed
Config Value: 43
Description: Increases the speed of your recycler

Name: Smelt_Speed
Config Value: 44
Description: Adds a chance for ore to smelt whenever wood is consumed, in addition to the standard smelt rate.

Name: Heli_Fuel_Rate
Config Value: 45
Description: Reduces the fuel consumption for your helicopters.

Name: Boat_Fuel_Rate
Config Value: 46
Description: Reduces the fuel consumption for your boats.

Name: Vehicle_Mechanic
Config Value: 47
Description: Allows the user to repair a vehicle at no cost.

Name: Reviver
Config Value: 48 
Description: Brings a wounded player up with additional health if the reviving player has the buff.

Name: Rationer
Config Value: 49
Description: Provides the consumer a chance to receive their food/tea back once consumed.

Name: PVP_Critical
Config Value: 50
Description: Gives the attacker a chance to critically damage the target in PVP.

Name: PVP_Damage
Config Value: 51
Description: Increases the damage of all PVP attacks.

Name: PVP_Shield
Config Value: 52
Description: Reduces the damage of all incoming PVP attacks.

Name: Metabolism_boost
Config Value: 53
Description: Increases your calories and hydration above the maximum.

Name: LootPickup
Config Value: 54
Description: Chance to have the loot from destroyed barrels given moved directly to their inventory.

Name: Node_Spawn_Chance
Config Value: 55
Description: Chance to spawn a new node when a new one is mined out.

Name: HealthRegen
Config Value: 56
Description: Passively regenerates x health per second

Name: AnimalTracker
Config Value: 57
Description: Allows the user to use the /track command to find the direction of the closest animal.

Name: ExtraPockets
Config Value: 58
Description: Creates a backpack style storage system, providing players the ability to access the storage using a chat command (/pouch). Slots are given based on points spent.

Name: Human_NPC_Damage
Config Value: 59
Description: Increases damages against scientists.

Name: Animal_NPC_Damage
Config Value: 60
Description: Increases damages against animals.

Name: Human_NPC_Defence
Config Value: 61
Description: Decrease damage from scientist.

 

The xp table uses a common equation to calculate its levels and xp requirements. You can read more about the method here: https://blog.jakelee.co.uk/converting-levels-into-xp-vice-versa/

There is also a spreadsheet you can make a copy of and adjust the x value at the top of. Increasing the number minimizes the xp between levels. Find a good value, then put it in the "x" value under the "Leveling information" section in the config.
It is recommended that you leave the y value at 2 or 3, and adjust the x value only.

Rule of thumb:

- 0.07: default
- 0.04: grindy.

 

API

object STCanGainXP(BasePlayer player, BaseEntity source)

Returning a non-null value will cancel the xp gain. Source can return null so be sure to check that.

string[] ST_GetPlayerLevel(BasePlayer player)

// Example
  
[ChatCommand("testapi")]
void TestAPI(BasePlayer player)
{
	var data = (string[])SkillTree.Call("ST_GetPlayerLevel", player);
	Puts($"Level: {data.First()}. XP: {data.Last()}");
}

Returns the players level [0] and xp [1] values as a string[]

object STCanReceiveYield(BasePlayer player, BaseEntity entity)

Returning a non-null value will cancel the yield gain.

object STOnLoseXP(BasePlayer player)

Returning a non null value prevents the xp loss.

double GetExcessXP(BasePlayer player)

Gets the excess xp over the players current level as a double.

RemoveXP(BasePlayer player, double value)

Removes xp from the player equal to the value. Will not reduce the value below the start of their current level.

void STOnPlayerLevel(BasePlayer player, int oldLevel, int newLevel);

Triggers when a player levels up. No return value.

void STOnPouchOpened(BasePlayer player, StorageContainer pouch)

Triggers when a player opens the ExtraPockets storage.

object STCanModifyHorse(BasePlayer player, RidableHorse horse, float modifier)

Returning a non-null value will prevent the horse from being modified by the Riding_Speed buff.