https://github.com/emilkrebs/playerprefs

An easy tool to set / get player preferences for each player in spigot
https://github.com/emilkrebs/playerprefs

easy-to-use minecraft-plugin spigot-plugin tool

Last synced: 16 days ago
JSON representation

An easy tool to set / get player preferences for each player in spigot

• Host: GitHub
• URL: https://github.com/emilkrebs/playerprefs
• Owner: emilkrebs
• License: mit
• Created: 2022-01-25T23:05:12.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-09T14:35:50.000Z (over 2 years ago)
• Last Synced: 2023-03-05T10:23:06.540Z (over 1 year ago)
• Topics: easy-to-use, minecraft-plugin, spigot-plugin, tool
• Language: Java
• Homepage:
• Size: 61.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  





  

   ![Price](https://img.shields.io/badge/price-FREE-34D058)

   [![Build](https://github.com/emilkrebs/PlayerPrefs/actions/workflows/build.yml/badge.svg)](https://github.com/emilkrebs/PlayerPrefs/actions/workflows/build.yml)








PlayerPrefs is an easy tool to get and set custom preferences for each player and save them in a yaml file.

## Getting started

Download the newest build from [releases](https://github.com/emilkrebs/PlayerPrefs/releases/). Now add the jar file as module to your project.

After that import using:

```Java

import org.qeston.playerprefs.utils.PlayerPrefs;

```

## Examples

Have a look at the [EasyMoneySystem](https://github.com/emilkrebs/EasyMoneySystem) example. 

This code example will count the deaths and kills of a player:

```Java

@EventHandler

public void onDeath(PlayerDeathEvent event) {

    Player killed = e.getEntity();

    Player killer = killed.getKiller();

    int deaths = PlayerPrefs.getInt(killed, "deaths") + 1;

    int kills = PlayerPrefs.getInt(killer, "kills") + 1;

    PlayerPrefs.setInt(killed, "deaths", deaths);

    PlayerPrefs.setInt(killer, "kills", kills);

}

```

## Methods

| Method        | Description   |

| ------------- |:------------- |

| getConfiguration| Get the Yaml Configuration for the player.                     |

| getFile       | Get the file where all the player preferences for the player are saved. |

| deleteKey     | Delete a key from the player's preference file.                         |

| hasKey        | Check if the key exists in the player's preference file.                |

| set           | Set the value of a single key in the player's preference file as Object.|

| setString     | Set the value of a single key in the player's preference file as string.|

| setInt        | Set the value of a single key in the player's preference file as integer.|

| setFloat      | Set the value of a single key in the player's preference file as float. |

| get           | Get the value of a single key in the player's preference file as Object.|

| getString     | Get the value of a single key in the player's preference file as string.|

| getInt        | Get the value of a single key in the player's preference file as integer.|

| getFloat      | Get the value of a single key in the player's preference file as float. |

## Known Issues

None

[Add Issue](https://github.com/emilkrebs/PlayerPrefs/issues/new)