Bukkit

WayOfShadows

Description

This plugin provides 6 assassin/rouge like skills. Backstab, PotionEffects, GrapplingHook, PickPocket and AirAssassination

You can use this plugin together with SkillLevels to make the skills levelable and/or to reward XP for using the skills.

Backstab is inspired from locutus's plugin Backstab. Grappling Hook is inspired from SalamiJack's plugin HookShot.

Compatibility

The GrapplingHook Skill uses NMS code, to prevent users from picking up arrows, shot by the plugin. If you plan to use this functionallity, you must use a CraftBukkit version, the plugin was made for.

Version 0.5 update notice

With Version 0.5 the config and permissions format changes. The config will be updated automaticly, the permissions however needs to be updated by hand.

Metrics

This plugin utilises Hidendra's plugin metrics system. You can opt-out under <yourPluginFolder>/PluginMetrics/config.yml

The following informations will be collected:

• A unique identifier
• The server's version of Java
• Whether the server is in offline or online mode
• The plugin's version
• The server's implementation and game version
• The OS version/name and architecture
• The core count for the CPU
• The number of players online
• The Metrics version
• Your online-mode
• Your server location

Skill description

Backstab: When you attack someone from behind you'll get a chance to do extra damage.

Effect: When you attack someone, your target may gets a certain potion effect (like poison or blindness).

Grappling Hook: When you throw a Arrow by rightclick, you can pull you to it with a configurable item (default: String). If there is no block where you could stand on, it`ll spawn a glass block for a given amount of time.

Pickpocket: When you are behind another player, you can right click him, which opens his inventory. Now you can try to steal a certain worth of items by left clicking the items in his inventory.

AirAssassination: When you attack a while falling down you'll deal more damage, depending on the distance you already fall.

LockPick: When you rightclick with a special item on a protected block, you have no right's for, you have a chance to use it anyways. E.g. protected doors or chests will open. Also, when a wooden door/fence gate/trap door/lever gets picked, it can't be opened for a defined amount of time. (Except by picking it again)

Usage

Permissions

• shadow.reload - access to /wayofshadows command, which reloads the plugin
• shadow.<skillname> - allows you to use this skill with every valid item
• shadow.<skillname>.item.<material> - allows you to use this skill with items with material <material>
• shadow.<skillname>.name.<name> - allows you to use this skill with items with name <name>
• shadow.<skillname>.lore.<lore> - allows you to use the skill with items which lore contains the String <lore> For PickPocket skills:
• shadow.<skillname>.exempt - player with this permission are safe from this skill

Configuration

The plugin creates a default configuration on startup, if there is no existing config.yml. It contains example setting for every skill.

You can add as many skills of every skill type as you want.

All values which require a number, can be a math forumla as well, if you use the plugin together with SkillLevels.
You can use + ,- ,* ,/ ,^ ,log(), sqrt(). ^ is expotential, like x^2 = x*x | log() = natural logarithm (base e) | sqrt() = sqare root

If you look for item/material names here.

General values, which every skill has:
type - the type of the skill. Valid types are "backstab", "effect", "grapplinghook", "pickpocket" and "airassassination"
lore - list of strings, which make this skill useable with items, that have one if these string within their lore.
items - list of item names (or item ids), which can be used for this skill
names - list of strings, which make this skill usable with items, that have these strings as name
levelSystem - name of the level system, which
cooldown - a number, which defines the cooldown of this skill in seconds
cooldownMsg - the string given to the player, when he tries to use this skill while is on cooldown. %time% will be replaced with the time in seconds.

Backstab values
chance - a number, which defines the chance of using this skill successful, must be between 0 and 1
critChance - a number, which defines the chance landing a critical hit, must be between 0 and 1
multiplier - a number, with which the damage get multiplied in case of a successful backstab
critMultiplier - a number, with which the damage get multiplied in case of a successful critical backstab
maxAngle - a number, which determines the maximum Angle, you can stand behind a target, in degree
onSneak - a boolean whether you need to sneak for this skill or not
critOnSneak - a boolean whether you need to sneak for a critical hit or not
attackerMsg - the message the attacker gets on a successful backstab
critMsg - the message the attacker gets on a critical backstab
victimMsg - the message the victim gets on a successful backstab

Effect values
effectType - the potioneffect type, which is used for this skill. Can be id and name.
chance - a number, which defines the chance of using this skill successful, must be between 0 and 1
maxAngle - a number, which determines the maximum Angle, you can stand behind a target, in degree
duration - a number, which defines the duration of the potion effect
strength - a number, which defines the strength of the potion effect

Hook values
pullLore - list of strings, which defines pull items if they contain one of these strings in their lore
pullItems - list of item names (or item ids), which can be used as pull items
pullNames - list of strings, which defines pull items if their name is given in this list
blockTime - a number, which determines the lifetime of the spawned glass block in server ticks (1 = 1/20 second)
maxDistance - a number, which defines the max distance to the hook
distanceToInitial - a number, which defines the max distance to your initial position
itemsPerBlock - the amount of items of per block distance, which will be consumed
distanceMsg - the message the player gets, when his hook is too far away
initialMsg - the message the player gets, when he is too far away from this initial position
errorMsg - the message the player gets, when he tries to hook to an invalid position
canPickupArrow - a boolean wether a player can pickup his hook arrow or not

AirAssassination
chance - a number, which defines the chance of using this skill successful, must be between 0 and 1
minHeight - the minimum height, required to activate this skill. This number will be substraced from the fall distance
maxHeight - the maximum height, for which you can get the damage bonus.
damgePerHeight - the amount of damage, that will be added to the attack per block fall distance
negateFallOnSuccess - whether the fall damage should be set to 0, when you successfully perform this skill
attackerMsg - the message the attacker gets on a successful air assassination (no message if empty)
victimMsg - the message the victim gets on a successful air assassination (no message if empty)

Pickpocket values
chance - a number, which defines the chance of using this skill successful, must be between 0 and 1
maxAngle - a number, which determines the maximum Angle, you can stand behind a target, in degree
maxDistance - a number, which defines the max distance to the player you are stealing from
maxValue - maximum worth of items you can steal per stealing session
onSneak - a boolean whether you need to sneak for this skill or not
abortOnDamage - whether the stealing process should be cancled if the stealing player gets damage
maxValueMsg - the message the stealer gets, when he reached his maxValue cap.
cantStealMsg - the message the stealer gets, when the item is not stealable
valueCatalogue - the name of the valueCatalogue, which should be used by this plugin. ValueCatalogues are explained below
stealFailedMsg - the message the stealer gets, when he failed to steal an item (no message if empty)
attemptStealMsg - the message the victim gets, when a thief failed to steal an item (no message if empty)

Lockpick values chance - a number, which defines the chance of using this skill successful, must be between 0 and 1. The variable 'y' defines the pick mod, defined in the "pickable" section
closeCooldown - a number, which defines how long doors/etc. can't be opened after a successful pick in seconds
damageOnFail - a number, which defines how much damage a player gets when he fails to pick a lock
loseItemOnFail - a boolean whether you lose your item when you fail to pick a lock
loseItemOnFail - a boolean whether you lose your item when you succed to pick a lock
successMsg - the message a player gets, when he successfully picks a lock
failMsg - the message a player gets, when he fails to pick a lock
sneakMsg - the message a player gets, when he tries to pick locks while sneaking (-> Vanilla behaviour, you don't open thinks while sneaking)
closeCooldownMsg - the message when you try to close/open a picked door
pickable - maps every pickable item to a modificator, which can be used in formulas.

ValueCatalogue
All value catalogues are define in the values.yml.
The values are additive. If you have a item, which matches in name and material, both values will be added together.
Items with values below 0 are not stealable. If you want items to be not stealable, give them a high negative value.

<nameofcatalogue>:
    defaultValue: -1
    items:
        <material>: <value>
    lore:
        <lore>: <value>
    names:
        <name>: <value>
    enchantments:
        <enchantment>:
            <level>: <value>

Events and SkillLevels

The plugin calls events, when an skill is successfully activated. (ShadowAirAssassinEvent, ShadowBackStabEvent, ShadowEffectSkillEvent, ShadowPickPocketEvent and ShadowPullEvent)

Also, the plugin provides support for SkillLevels, what allows you to reward xp for successfull skill activation. Just add "shadow_<skillname>: <xp>" under the CUSTOM section of your level system's config. Xp are awarded per successful skill usage.

Source

This plugin is open Source. It's code can be found on GitHub