Configuration
KarmicShare YAML configuration
config.yml
This will explain all the options in the config.yml file.
Note, upperPercent must be higher than lowerPercent. If not, it will automatically use the defaults. Same for upperlimit and lowerlimit.
Also, karmaChange must be a positive integer, else it will go to default. It can be zero, for instance, if you only want karma changes for items specified in the karma.yml.
Same with listlimit, the value must be a positive integer, but must also be larger than 1.
If playerDefaultKarma is out of range of the given upper and lower limit, it will set it to the average of the range.
karma:
- static: If true, all items give the same karma. If false, uses the per-item karma.yml to give karma multipliers for specified items. (Default: false)
- change
- give: The default amount of karma change with giving an item, if the specific item karma is not specified. (Default: 1)
- take: The default amount of karma change with taking an item, if the specific item karma is not specified. (Default: 1)
- playerDefault: The default amount of karma a player starts with. (Default: 0)
- upper
- limit: The high limit of the karma range. (Default: 200)
- percent: The percentage of what is considered the high "good" range. (Default: 0.85)
- lower:
- limit: The low limit of the karma range. (Default: -200)
- percent: The percentage of what is considered the low "bad" range. (Default: 0.15)
- disabled: Completely disable the karma system. Players can still share items, but no karma checks or changes will be made. (Default: false)
effects: If true, will use smoke effect on player when they give/take items to/from the pool. (Default: true)
listlimit: Amount of item entries to show per page of the list command, /ks list. (Default: 10)
chests: If true, allows for chests/signs for the plugin to be made/used. (Default: true)
version: Current config/database version. Used for auto-updating mechanic, so don't edit this.
mysql:
- use: Whether or not to use mysql. If false, it will use SQLite. (Default: false)
- host: Hostname / IP address of SQL server. (Default: localhost)
- port: The port to use to connect to the SQL server. (Default: 3306)
- database: The name of the database to use. (Default: minecraft)
- user: Username to use to log into SQL server. (Default: username)
- password: Password to use to log into SQL server. (Default: pass)
- tablePrefix: The table's prefix, as an identifier for the plugin. No real point in changing it unless you know what you're doing... (Default: ks_)
- import: Whether or not to import data from SQLite to MySQL. This will automatically set itself to false after it imports to prevent duplication. (Default: false)
debug:
- time: Show how long a command takes, in nanoseconds (Default: false)
- database: Print exception stack trace in regards to the database (Default: false)
karma.yml
This explains the per-item karma multiplier yaml file.
All item multipliers MUST be integers. If not, there's no guarantee that it will load that entry.
Entries follow standard yaml format.
You do not need to have karma values associated with every item or data value. If an item is missing, or a data value for an item is missing, it will automatically default to the default karma value from the config.yml. Therefore, you only need to add items you want a multiplier for.
Note, the key name for the entries can be anything you want.
Example entry:
Diamond: itemid: 264 give: 25 take: 35
This makes each diamond (256) give 25 karma points when given to an item pool and cost 35 karma points when taken.
If an item has data values, such as wool, then you need to specify it with a different key:
OrangeWool: itemid: 35 data: 1 give: 6 take: 6
This makes orange wool (35:1) have 6 karma points for both actions.
Comments