README.md 1.9 KB
Newer Older
1 2 3
# RetainXP

**NOTE: This project has been previously called "XPKeeper" but has been renamed to RetainXP as there already exists [another project](https://www.curseforge.com/minecraft/bukkit-plugins/xpkeeper) with the same name.**
Michael Wieland's avatar
Michael Wieland committed
4 5 6

A Minecraft Bukkit plugin which prevents loosing all your XP after death.

Michael Wieland's avatar
Michael Wieland committed
7 8
<img src="logo.png" alt="Logo" height="300"/>

9 10
[![pipeline status](https://gitlab.com/Programie/RetainXP/badges/master/pipeline.svg)](https://gitlab.com/Programie/RetainXP/commits/master)
[![download latest release](https://img.shields.io/badge/download-latest-blue.svg)](https://gitlab.com/Programie/RetainXP/-/jobs/artifacts/master/raw/target/RetainXP.jar?job=release)
Michael Wieland's avatar
Michael Wieland committed
11

12 13 14 15 16 17
## What is it?

Are you annoyed to lose all your XP just because you didn't heard a Creeper behind you?

RetainXP allows you to keep a part of your XP after you die. For example, you can configure it to keep 50% of your XP on death instead of losing all of it.

Michael Wieland's avatar
Michael Wieland committed
18 19
## Installation

20
You can get the latest release from [GitLab](https://gitlab.com/Programie/RetainXP/-/jobs/artifacts/master/raw/target/RetainXP.jar?job=release).
Michael Wieland's avatar
Michael Wieland committed
21 22 23

## Permissions

24
Currently, there is only one permission available: `retainxp.retain` (Default: everyone)
Michael Wieland's avatar
Michael Wieland committed
25 26 27

## How does it work?

28
On player death (and if the player has the `retainxp.retain` permission) the current XP level is multiplied with the `multiplier` value specified in the [config.yml](src/main/resources/config.yml) file (which defaults to 1.0). On respawn, the new player level will be the calculated value.
Michael Wieland's avatar
Michael Wieland committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42

Examples:

* If the multiplier is set to 1.0 and you die on XP level 60, you will be respawned with XP level 60.
* If the multiplier is set to 0.5 and you die on XP level 60, you will be respawned with XP level 30.

## Build

You can build the project in the following 2 steps:

 * Check out the repository
 * Build the jar file using maven: *mvn clean package*

**Note:** JDK 1.8 and Maven is required to build the project!