MassDrugs

From SupaHam
Revision as of 00:37, 19 May 2014 by SupaHam (Talk | contribs) (Added note for color support)

Jump to: navigation, search

MassDrugs

MassDrugs is a plugin created by SupaHam, for the MassMC server. This plugin introduces completely configurable drugs, with overdose effects, etc.

Commands

Tip: Confused with command syntax or want to make the most out of them? Head over here for help.
Parent Command Permission Aliases Description
massdrugs massdrugs drugs MassDrugs main command.
massdrugs add massdrugs.add Adds a drug's property value.
massdrugs set massdrugs.set Set drug properties.
massdrugs remove massdrugs.remove rm Removes a drug's property value.
massdrugs create <drug> massdrugs.create c Creates a new drug. HEISENBERG! The item in your hand will be the drug.
The <drug> argument is the name of the drug you're creating. Note that this name can not change once set, though drugs can have display names, which is used for display.
massdrugs delete <drug> massdrugs.delete del Deletes a drug.
The <drug> argument is the name of the drug you're deleting.
massdrugs save massdrugs.save Puts the drugs in the bag (Saves the drugs to the configuration file).
massdrugs reload massdrugs.reload rl Reloads the drugs configuration file.
massdrugs give <drug> [player] [amount] massdrugs.give gib Gives a player drugs.
The <drug> argument is the name of the drug you're going to give.
The [player] argument is the player you wish to give the drugs to.
The [amount] argument is the amount of drugs to give.
massdrugs list massdrugs.list ls Lists all the drugs.
massdrugs set name <drug> <name> massdrugs.set.name Set a drug's display name.
The <drug> argument is the name of the drug you're modifying.
The <name> argument is the display name you wish to set the <drug> to.
massdrugs set summary <drug> <summary> massdrugs.set.summary Set a drug's summary.
The <drug> argument is the name of the drug you're modifying.
The <summary> argument is the summary you wish to apply to <drug>.
massdrugs set description <drug> <description> massdrugs.set.description desc Set a drug's description.
The <drug> argument is the name of the drug you're modifying.
The <description> argument is the description you wish to apply to <drug>.
massdrugs set message <drug> <message> massdrugs.set.message msg Set a drug's message.
The <drug> argument is the name of the drug you're modifying.
The <message> argument is the message (sent to the consumer) you wish to apply to <drug>.
massdrugs set item massdrugs.set.item Set a drug's item to the item in your hand.
The <drug> argument is the name of the drug you're modifying.
massdrugs set use-threshold <drug> <threshold> massdrugs.set.use-threshold threshold Set a drug's use threshold.
The <drug> argument is the name of the drug you're modifying.
The <use-threshold> argument is the use threshold, the uses before a player overdoses.
massdrugs set use-reset-time <drug> massdrugs.set.use-reset-time reset-time, time Set a drug's use reset time.
The <drug> argument is the name of the drug you're modifying.
The <time> argument is the time (in seconds) a player's drug use decrements.
massdrugs set overdose-percentage <drug> <percentage> massdrugs.set.overdose-percentage odpct Set a drug's overdose percentage.
The <drug> argument is the name of the drug you're modifying.
The <percentage> argument is the chance (from 100%) that a player will overdose once they passed the use-threshold.
massdrugs add effect [-o] <drug> <type> <duration> <amplifier> [ambient] massdrugs.add.effect Adds a potion effect.
The <drug> argument is the name of the drug you're modifying.
The <type> argument is the type of the potion effect you wish to apply to <drug>, click here for a list of potion effect types.
The <duration> argument is the duration (in minecraft ticks) that the effect will last.
The <amplifier> argument is the level of the potion effect starting from 0 (level 1).
The [ambient] argument is whether the effect should be ambient (barely visible).
If the [-o] flag is present, the change will apply to the overdose effect instead of the normal drug use effect.
massdrugs remove effect [-o] <drug> <type> massdrugs.remove.effect Removes a potion effect.
The <drug> argument is the name of the drug you're modifying.
The <type> argument is the type of the potion effect you wish to remove from <drug>, click here for a list of potion effect types.
If the [-o] flag is present, the change will apply to the overdose effect instead of the normal drug use effect.

Configuration

Tip: Before starting to mess around with a configuration file, please head over here and familiarise yourself.

drugs.yml

Configuration Value Description
drugs Section This section contains all the drugs that the plugin recognises.
drugs.<drug> Section This section represents a single drug's configuration. It is very important that you do not modify the <drug> name.
drugs.<drug>.name String The name of the <drug>. It is very important that you do not modify this. This and <drug> are used to identify the drug and should be hidden from the gameplay aspect.
drugs.<drug>.display-name String The display name of the <drug>. The display name is what is used in messages. (Supports colors).
drugs.<drug>.summary String A summary of the <drug>. (Supports colors).
drugs.<drug>.description String A description of the <drug>. (Supports colors).
drugs.<drug>.message String The message that is sent to the player that consumes the <drug>. (Supports colors).
drugs.<drug>.use-threshold Integer The use threshold before a player overdoses of the <drug>.
drugs.<drug>.use-reset-time Integer The use-reset time of the <drug>.
drugs.<drug>.overdose-percentage Float The chance of the consumer overdosing once they've passed their use threshold.
drugs.<drug>.drug-effects Potion Effect The drug effects to be applied to the consumer.
drugs.<drug>.overdose-effects Potion Effect The overdose effects to be applied to the consumer, if they overdose.
drugs.<drug>.item ItemStack The item this drug represents. This is the item that is needed to be interacted with in order to consume the drug. It is extremely important that you do not modify the lore from '==START HIDDEN LORE==' to '==END HIDDEN LORE'. This is used in order for the plugin to keep track of the item, and is done like this for efficiency.