-
Notifications
You must be signed in to change notification settings - Fork 1
Configuration
Below is the default config.yml. In case something goes wrong with your configuration file, you can copy and paste the default config provided below into your config file.
Config.yml
### AVAILABLE LANGUAGES - English, Spanish, Italian, Russian, Vietnamese, Simplified Chinese, French, Dutch.
Language: English
#Level of debugging:
#NONE: No debugging will be made.
#LOW: debugging on start-up and shut-down
#HIGH: debugging on Karma changes and alignment changes, plus the above
Debug Level: NONE
#Whether commands should play sounds when being used.
Command Sound: true
###STORAGE CONFIGURATION####
#Storage Type
#1: Json
#2: MySQL Database
#When changing storage type, to easily move the data from Json to the database simply do '/karma reload' followed by '/karma save' after changing this field.
Storage Type: 1
#Auto-save interval (In seconds)
Autosave Interval: 120
###DATABASE CONFIGURATION###
Database:
Name: name
Host: host
Port: 8888
Username: root
Password: password
#---------------------------------KARMA PREFERENCES----------------------------------------#
#The default starting score for players. Can be any number that is an integer. Keep in mind that 2147483647 is the highest integer usable, while
#-2147483647 is the lowest.
Starting Score: 0
#The size that a player's Karma History should be. Lower values results in higher performance.
#This change takes effect after reloading/restarting the server.
Karma History Size: 10
#How often players karma gain/loss limits should reset (in seconds). Very low numbers may cause lag.
Karma Limit Reset Interval: 3600
#https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html
#What particles should play around the player upon gaining Karma. The amount of particles changes based on the amount of Karma gained.
#Typing "null" will result in no particles playing.
Karma Gain Particle: VILLAGER_HAPPY
#https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html
#What particles should play upon the player losing Karma. The amount of particles changes based on the amount of Karma lost.
#Typing "null" will result in no particles playing
Karma Loss Particle: SPELL_WITCH
#Whether the karma limit should be a soft cap or not.
#If this is set to true, a player's Karma will change even if it would go over their alignment's Karma limit, as long as they are not above it before the Karma has changed.
# - Example: Player's alignment limit is 300 Karma. The player's current recent Karma is 290, and they gain 30 from a single source.
# The player gains the 30 Karma, reaching 320 recent Karma. Their Karma will not change any further until the recent Karma is reset.
#If this is set to false, a player's Karma will not change if it would go over their current Karma limit.
# - Example: Player's alignment limit is 300 Karma. The player's current recent Karma is 290, and they lose 15 from a single source.
# The player does not lose any Karma, as it would go over their alignment's limit.
Karma Soft Cap: true
#Gamemodes which Karma will take effect.
Enabled GameModes:
- SURVIVAL
- ADVENTURE
#True: The list below will be worlds where Karma will be enabled
#False: The list below will be worlds where Karma will be disabled
Enabled World List: true
Worlds:
- world
- world_nether
- world_the_endAllows you to change the plugin's language. The languages supported are the ones written in the comment above this section.
Where you choose the debugging level of the plugin. This should be left untouched generally, and is used only when debugging the plugin in case something goes wrong.
Where you can change how often the plugin should save data automatically. It is recommended to keep this value above 60, as saving more often than once a minute might result in lag.
Where you decide how you want to store the plugin's player data. Setting this to 1 will store data in JSON files, creating a file named after a player's UUID to store their information. Setting this to 2 will store data in an existing MySQL database. Continue below for more information about this.
Where you provide Karma Overload with your database information. You will need to write the following:
- Your database's name
- Your Host
- Your Host's port
- The username Karma Overload will access the database with
- The password for the username provided above
What the default Karma Score a player starts from should be. This change will also affect commands such as /karma clear & /karma reset
How many entries a player's Karma History should store at a time. Lower numbers will result in higher performance.
How often the server's Karma Limit should reset (in seconds). Player's Karma Limit is stored individually, it being the number provided in their alignment's YAML file.
What particles should play when a player gains Karma from any source. The amount of particles playing is equal to the Karma gained x 2.
What particles should play when a player loses Karma from any source. The amount of particles playing is equal to the Karma lost x 2.
Whether commands should play a clicking sound to the player when used.
Whether an Alignment's Karma limits should soft cap or hard cap. When this is set to true, if a player gains/loses Karma exceeding their Karma limit they will gain/lose that Karma amount, but their Karma won't change anymore after that as its limit has been surpassed. When this is set to false, if a player is meant to gain/lose Karma that would exceed their Karma limit their Karma will remain unchanged as its limit cannot be surpassed.
What Game-Modes players should be able to gain/lose Karma & be affected by Karma Effects.
How the world list found in the config.yml should be interpreted. Setting this to true will enable Karma for the worlds in the list. Setting this to false will disable Karma for the worlds in the list.
The list of worlds where Karma should be enabled/disabled.