Skill Tree 1.2.2

 

 

 

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:

• 78 unique buff types.
• 11 unique skill trees.
• 59 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: 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.

Command: stgiveitem
Parameters: <id> <shortname> <quantity> <skin ID> <optional: displayName>
Description: gives an item to the target ID that matches the parameters.

 

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
Harbor_Event_Winner - Winner of the Harbor event plugin.
Junkyard_Event_Winner - winner of the Junkyard event plugin.
PowerPlant_Event_Winner - winner of the Power plant event plugin.
Satellite_Event_Winner - winner of the Satellite event plugin.
Water_Event_Winner - winner of the Water event plugin.
Air_Event_Winner - winner of the Air event plugin.
Armored_Train_Winner - winner of the Armored train plugin.
Convoy_Winner - winner of the Convoy event plugin.
Supply_drop - first player that opens a supply drop.

 

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

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

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

Name: Mining Luck
Key: 4
Value: 1
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
Key: 5
Value: 1
Description: Decreses the durability loss of mining tools.

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

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

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

Name: Woodcutting Luck
Key: 9
Value: 1
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
Key: 10
Value: 1
Description: Decreses the durability loss of woodcutting tools.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name: ExtraPockets
Key: 58
Value: 4
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
Key: 59
Value: 1
Description: Increases damages against scientists.

Name: Animal_NPC_Damage
Key: 60
Value: 1
Description: Increases damages against animals.

Name: Human_NPC_Defence
Key: 61
Value: 1
Description: Decrease damage from scientist.

Name: Craft_Duplicate
Key: 62
Value: 1
Description: Chance to duplicate an item while crafting.

Name: WaterBreathing
Key: 63
Value: 2
Description: Breath underwater.

Name: SharkResistance
Key: 64
Value: 1
Description: Reduce damage taken from sharks.

Name: SharkSkinner
Key: 65
Value: 1
Description: Chance to receive random items while skinning sharks.

Name: DeepSeaLooter
Key: 66
Value: 1
Description: Chance to receive additional items while looting sunken crates.

Name: InstantUntie
Key: 67
Value: 0
Description: Instantly untie sunken crates.

Name: UnderwaterDamageBonus
Key: 68
Value: 1
Description: Increase damage to all living things while underwater (including underwater labs).

Name: Permission
Key: 69
Value: 5
Description: Used for permission based skills.

Name: Woodcutting_Ultimate
Key: 991
Value: 0
Description: Harvests the surrounding trees when cutting down a tree.

Name: Mining_Ultimate
Key: 992
Value: 0
Description: Provides access to a chat command to see all surrounding node locations.

Name: Combat_Ultimate
Key: 993
Value: 0
Description: Heals the player for a percentage of the damage that they deal to all sources.

Name: Vehicle_Ultimate
Key: 994
Value: 0
Description: Reduces damage dealt to the players mounted vehicle (default 100% deduction).

Name: Harvester_Ultimate
Key: 995
Value: 0
Description: Allows the player to set the genetic composition of plants.

Name: Medical_Ultimate
Key: 996
Value: 0
Description: Gives the player a chance to resurrect at their point of death if they choose to.

Name: Skinning_Ultimate
Key: 997
Value: 0
Description: Killing an animal with this buff active will provide the player with an enhanced ability for a period of time, depending on the animal killed.
- Chicken: No fall damage.
- Boar: Chance to find components while harvesting mushrooms and berries.
- Wolf: Increased healing while near team mates.
- Stag: Notification when a neutral player is nearby, and their last known location (configurable).
- Bear: Scientists will not attack the player unless attacked.
- Polarbear: Overshield.

Name: Build_Craft_Ultimate
Key: 998
Value: 0
Description: Use any coloured swipe cards in any reader.

Name: Scavengers_Ultimate
Key: 999
Value: 0
Description: Will automatically recycle components from barrels when they are broken.

 

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.

public void AddNode(string tree, string node, bool enabled, int max_Level, int tier, float value_Per_Buff, string _buff, string _buffType, string icon_url, object[] _perms = null)
  
object[] perms { string perms_description, Dictionary<int, List<string>> tiers_and_perms }

        void AddCookingNodeToSkillTree()
        {
            if (SkillTree != null && SkillTree.IsLoaded)
            {
                Dictionary<int, Dictionary<string, string>> _perms = new Dictionary<int, Dictionary<string, string>>()
                {
                    [1] = new Dictionary<string, string>() { ["cooking.instant"] = "Instant Cook" }
                };
                string Description = "Cooking food with the Cooking plugin will be instant.";

                object[] perms = new object[]
                {
                    Description,
                    _perms
                };

                string Tree = "Cooking";
                string Node = "Instant Chef";
                bool StartOn = true;
                int Max_Level = 1;
                int Tier = 2;
                float Value_per_Level = 1;
                string Buff = "Permission";
                string BuffType = "Permission";
                string URL = "https://i.imgur.com/3TMqFKG.png";

                SkillTree.Call("AddNode", Tree, Node, StartOn, Max_Level, Tier, Value_per_Level, Buff, BuffType, URL, perms);
            }
        }

Allows plugins to add custom nodes to trees.

        [HookMethod("IsExtraPocketsContainer")]
        public object IsExtraPocketsContainer(uint uid)
        {
            if (containers.ContainsKey(uid)) return True;            
            return False;
        }

        [HookMethod("GetExtraPocketsContainerProvider")]
        public Func<uint, bool> GetExtraPocketsContainerProvider()
        {
            return new Func<uint, bool>(uid =>
            {
                if (containers.ContainsKey(uid)) return true;               
                return false;
            });
        }

        [HookMethod("GetExtraPocketsOwnerIdProvider")]
        public Func<uint, string> GetExtraPocketsOwnerIdProvider()
        {
            return new Func<uint, string>(uid =>
            {
                Containers data;
                if (containers.TryGetValue(uid, out data)) return data.userIDString;
                return null;
            });
        }

API for extra pockets.