How to Install & Configure

How to Install

To install FreeRPG on any Spigot server, simply drag the freerpg-{version}.jar file into the /plugins folder of your server and restart/start your server.

To ensure a stable and fun experience for your players, please make sure to back up the FreeRPG/PlayerDatabase folder regularly. This folder contains the progress of all players on your server. Each player will get its own file in the PlayerDatabase folder, in which the personal stats of the player are saved.

How to Configure

FreeRPG can be configured with the files located in the /plugins/FreeRPG folder.

• languages.yml contains all available translations of the plugin that a player can use in game. If your desired language is not provided by default, you can translate it yourself. It is not that complicated, check out the CONTRIBUTING file in the repository for further information. Please open an issue and provide your translation, so everybody can benefit from your translation as well.
• config.yml contains all configuration to turn on/off skills, set maximum levels, change experience multiplier and change ability cooldowns.
• advancedConfig.yml contains all other configuration of the plugin. Its configuration will be explained in a more detailed way below.

Advanced Configuration

This configuration can be done in the advancedConfig.yml file. A detailed description of what an option does is provided behind each option in the configuration file.

• general (starts at line 24) contains all general configuration about the plugin.

• tokens (starts at line 44) contains all configuration related around skill tokens, global tokens and passive tokens. A custom amount of tokens that each player will have at the beginning can be set as well.

• souls (starts at line 66) settings related to souls.

• leveling (starts at line 69) contains settings which define the experience curve. If you want to change it, please check this desmos (graph plotter website) link. This makes it easy to visualize and change the curve to your needs. If you made changes to balance the play experience, please contribute them by opening an issue.

• digging (starts at line 79) related configuration about the Digging Skill. Define drops or change certain amounts of experience gained when breaking blocks.

• woodcutting (starts at line 154) related configuration about the Woodcutting Skill. Define drops or change certain amounts of experience gained when breaking blocks.

• mining (starts at line 210) related configuration about the Mining Skill. Define settings of the VeinMiner ability or change certain amounts of experience gained when breaking blocks.

• farming (starts at line 272) related configuration about the Farming Skill. Change certain amounts of experience gained when breaking crops/mushrooms or killing animals and define custom crafting recipes.

• fishing (starts at line 344) related configuration about the Fishing Skill. Define Tier drops and change certain amounts of experience gained when catching/killing fish or robbing entities.

• archery (starts at line 470) related configuration about the Archery Skill. Change certain amounts of experience gained when killing entities.

• beastMastery (starts at line 551) related configuration about the Beast Mastery Skill. Change certain amounts of experience gained when taming/killing entities.

• swordsmanship (starts at line 638) related configuration about the Swordsmanship Skill. Change certain amounts of experience gained when killing entities.

• defense (starts at line 721) related configuration about the Defense Skill. Change certain amounts of experience gained when killing entities, taking damage, etc.

• axeMastery (starts at line 807) related configuration about the Axe Mastery Skill. Change certain amounts of experience.

• repair (starts at line 890) related configuration about the Repair Skill. Change certain amounts of experience gained when killing entities.

• agility (starts at line 942) related configuration about the Agility Skill. Change certain amounts of experience gained when killing entities.

• alchemy (starts at line 950) related configuration about the Alchemy Skill. Define custom crafting recipes, custom potions and change certain amounts of experience.

• smelting (starts at line 1057) related configuration about the Smelting Skill. Change certain amounts of experience gained when killing entities.

• enchanting (starts at line 1100) related configuration about the Enchanting Skill. Define custom crafting recipes and change certain amounts of experience.

Note: A mob farm multiplier exists that reduces the experience gain from killing mobs in mob farms (Mob farms are determined by entity density)