Skip to content
Rowan edited this page Jul 28, 2022 · 7 revisions

Welcome to the CustomAdvancements wiki! Here you find all the information you need to correctly configure the plugin!

How to start?

Assuming you installed the plugin and restarted the server to load it the plugin directory should be created, this directory contains 1 file, messages.yml and two sub-directories, data and advancement-trees. If this is the first time you start the plugin you will also notice an example.yml file inside the advancement-trees folder, this is a tree configuration. Now the plugin is successfully loaded and we can continue with configuring it!

Commands & Permissions

As command you can use both /ca <subcommand> or /customadvancements <subcommand>

Commands

Command Usage Description Permission
/ca help /ca help This command will show all sub-commands you have permission for customadvancements.command.help
/ca activate /ca activate <tree> <advancement> When you execute this command you will try to activate an advancement, this will fail if you do not meet all requirements customadvancements.command.activate
/ca reload /ca reload This command will reload all messages and configurations customadvancements.command.reload
/ca checkprogress /ca checkprogress <tree> <advancement> [player] This will show the progression made in a specific advancement customadvancements.command.checkprogress
/ca gui /ca gui Opens the CustomAdvancements gui, alias is /advancements customadvancements.gui
/ca set /ca set <active|progress|completed> <tree> <advancement> <value> [player] Sets an attribute of an advancement for a player, progression, if the quest is active or completed customadvancements.command.set
/ca grantimpossible /ca grantimpossible <player/uuid> <advancement_path> Grants progress to an advancement of the 'impossible' type customadvancements.command.grantimpossible

Permissions

Permission Description Default
customadvancements.command.help Allows a player to do the /ca help command everyone
customadvancements.command.activate Allows a player to do the /ca activate command everyone
customadvancements.command.reload Allows a player to reload the plugin OP
customadvancements.command.checkprogress Allows the player to do /ca checkprogress for themselves everyone
customadvancements.command.checkprogress.others Allows the player to do /ca checkprogress for other players OP
customadvancements.gui Allows the player to view the GUI everyone
customadvancements.command.set Allows the player to do /ca set OP
customadvancements.command.grantimpossible Allowed the player to do /ca grantimpossible OP

Plugin Directory

Messages.yml

This file, as the name already suggests, contains all the messages of the plugin. If you wish to localize the plugin you can do so by replacing the strings in this file!

data directory

You don't have to do anything with this directory, it stores the data for players.

advancement-trees directory

This directory contains all the different tree configurations, if you want to create new advancements you need to create a new .yml file with as name the identifier of your advancement tree, this name may not include spaces! See Tree configurations on how to create a new advancement tree.