PlayerPoints is a simple and efficient currency plugin, adding the ability to manage points for players. Its features can be used by plugins that directly support PlayerPoints, or optionally through Vault.

If you need any help with our plugins, including any questions to ask, any bugs to report, or you just want to chat, join our Discord server! We offer all support through our server, so feel welcome to join if you need any assistance.

To install the plugin, visit our Spigot page and hit the big download button. This will download a jar file. Make sure your server is turned off first, and then put that jar file into your server's /plugins folder. After it's in the folder, go ahead and start up your server. After your server is finished starting up, you should be able to find a PlayerPoints folder in the /plugins/PlayerPoints directory, which contains all of the configuration files and data files for PlayerPoints.

Dependencies
None! Optionally, we support Vault and PlaceholderAPI. The hook for Vault is disabled by default but can be enabled in the config.yml.

In a more advanced method, you can compile the plugin yourself from the GitHub. PlayerPoints uses Gradle to compile and build the plugin. To use this method, run ./gradlew build in the project's root directory to build the jar. The plugin jar should be located in ./build/libs when finished.

There are two different uses for PlaceholderAPI in PlayerPoints. The first is using the custom placeholders that PlayerPoints provides, which can be found below. The second is the ability to use any placeholder in any message in PlayerPoints. These messages can be edited in your locale file.

This page contains all of the commands and permissions for PlayerPoints.

To use these commands, you are required to have the permission nodes that are associated with them. If you are /OP on your server, you are typically given all of the permissions for your plugins, so you don't have to assign them manually.

If you are not someone to give OP status to all of your members (which is definitely something that most people avoid!), you will need a permissions plugin in order to assign these permissions to your members. We suggest using LuckPerms to set up permissions. It has an extensive wiki that explains everything you need to know in order to set it up.

Aliases for PlayerPoints commands include /points, /playerpoints, and /p. You can use any of these to replace the /points that appears before the command arguments that are listed above.

For these commands, if you ever see text within <brackets>, you will need to include them in your command arguments. Arguments are things that you need to include in the command to make them work in the way that you want. You will ignore the brackets themselves, but will write what you want in place of the listed argument.

If something is confusing to use, please visit our Discord server for more help. We can't offer support for any issues or setup for permissions plugins, but we can help you with any PlayerPoints issues or questions you might have.

PlayerPoints contains an API for looking up and modifying a player's points balance.

I recommend that you use either Gradle or Maven to include the dependency for PlayerPoints in your project. Do not shade the entire plugin into your jar, it should only be added as an implementation. An alternative to using a dependency manager is to download the jar and reference it within your IDE manually.

Replace $VERSION$ with the version of the plugin you are using. Versions 3.0.0 and newer are available.

repositories {
    maven {
        url = 'https://repo.rosewooddev.io/repository/public/'
    }
}

dependencies {
    compile 'org.black_ixx:playerpoints:$VERSION$'
}

<repositories>
    <repository>
        <id>rosewood-repo</id>
        <url>https://repo.rosewooddev.io/repository/public/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>org.black_ixx</groupId>
        <artifactId>playerpoints</artifactId>
        <version>$VERSION$</version>
    <scope>provided</scope>
    </dependency>
</dependencies>

In order to use the API, you must first acquire an API instance. An example plugin class that does this can be found below.

import org.black_ixx.PlayerPointsAPI;
import org.bukkit.Bukkit;
import org.bukkit.plugin.java.JavaPlugin;

public class Example extends JavaPlugin {
    private PlayerPointsAPI ppAPI;

    @Override
    public void onEnable() {
        if (Bukkit.getPluginManager().isPluginEnabled("PlayerPoints")) {
            this.ppAPI = PlayerPoints.getInstance().getAPI();
        }

        // When you want to access the API, check if the instance is null
        if (this.ppAPI != null) {
            // Do stuff with the API here
        }
    }
}

You will need to add softdepend: [PlayerPoints] or depend: [PlayerPoints] to your plugin.yml depending on if your plugin requires PlayerPoints to be installed or not.