Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
CleverNucleus committed Sep 1, 2021
1 parent 5315489 commit 287b7ca
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# PlayerEx
An API mod for Minecraft that expands and improves the attributes system, exposing player attributes through datapacks.
A Minecraft mod built using the Fabric ecosystem that adds RPG attributes to the game and the player.

#### Content


The content added by this mod can be summarised in a few bullet points:

- Exposes all player attributes (defined as entity attributes that apply to the player) through datapacks, allowing for easy modifications such as adding new attributes and/or changing default/base values of attributes.
- Implements a new system for modifying player attribute values: this allows the modification of attribute values to affect other attributes (e.g. adding 1 to constitution could also add 1 to max health).
- Adds a new gui button to the player's survival inventory, which opens a new screen showing all attribute values, including levels, skill points and buttons to level up attributes (a slight RPG theme).
- Provides an API to allow interfacing with the attributes system by other mods.

For a comprehensive breakdown of in game content, see the [CurseForge mod page](https://www.curseforge.com/minecraft/mc-mods/player-ex). For Devs who want to use the API, please see the [Github wiki](https://github.com/CleverNucleus/PlayerEx/wiki).
For a comprehensive breakdown of in game content, see the [CurseForge mod page](https://www.curseforge.com/minecraft/mc-mods/player-ex). For further documentation and details on how to use the API in your own mod, please see the [Github wiki](https://github.com/CleverNucleus/PlayerEx/wiki).

0 comments on commit 287b7ca

Please sign in to comment.