diff --git a/README.md b/README.md index 8ae0f859..d7edd1cc 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,112 @@ ![logo](https://cdn.modrinth.com/data/cached_images/f8dd730cf295dc3a449337df81cc47e010eddf3e.png) -[![GitHub license](https://img.shields.io/badge/MIT-MIT?style=for-the-badge&label=LICENCE&labelColor=582b11&color=a48350&link=https%3A%2F%2Fgithub.com%2FPlayerEXDirectorsCut%2Fplayerex%2Fblob%2F1.20.1%2Fmain%2FLICENSE)](https://github.com/PlayerEXDirectorsCut/playerex/blob/1.20.1/main/LICENSE) -[![GitHub stars](https://img.shields.io/github/stars/PlayerEXDirectorsCut/playerex?style=for-the-badge&logo=github&color=ffb046&link=https%3A%2F%2Fgithub.com%2FPlayerEXDirectorsCut%2Fplayerex%2Fstargazers -)](https://github.com/PlayerEXDirectorsCut/playerex/stargazers) -[![GitHub forks](https://img.shields.io/github/forks/PlayerEXDirectorsCut/playerex?style=for-the-badge&logo=github&link=https%3A%2F%2Fgithub.com%2FPlayerEXDirectorsCut%2Fplayerex%2Fforks -)](https://github.com/PlayerEXDirectorsCut/playerex/forks) -[![GitHub issues](https://img.shields.io/github/issues/PlayerEXDirectorsCut/playerex?style=for-the-badge&logo=github&label=ISSUES&link=https%3A%2F%2Fgithub.com%2FPlayerEXDirectorsCut%2Fplayerex%2Fissues -)](https://github.com/PlayerEXDirectorsCut/playerex/issues) -[![docs](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/generic_vector.svg)](https://playerexdirectorscut.github.io/Bare-Minimum-Docs/) -![mkdocs](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/mkdocs_vector.svg) -![java17](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/java17_vector.svg) -[![curseforge](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/curseforge_vector.svg)](https://www.curseforge.com/minecraft/mc-mods/playerex-directors-cut) -[![modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/mod/playerex-directors-cut) +
Forge when?
-### Preamble + -PlayerEX: Directors Cut is port of **[PlayerEx](https://www.curseforge.com/minecraft/mc-mods/playerex)**, a mod built using Fabric that adds RPG themed attributes to the game and the player. It is available to download from [Curseforge](https://curseforge.com/minecraft/mc-mods/playerex-directors-cut) and [Modrinth](https://modrinth.com/mod/playerex-directors-cut). +
+
+
+
+
+
+
+
+
+
+
(though more assembly is required, see further below)
-In addition to attributes powered by [Data Attributes: Directors Cut](https://www.curseforge.com/minecraft/mc-mods/data-attributes-directors-cut), PlayerEX: Directors Cut adds a levelling system and skill points to spend, enabled through a nonintrusive vanilla-styled gui accessible from the inventory or by hotkey. For further documentation, as well as how to use the PlayerEX:Directors Cut API in your own project, please see the [wiki](https://github.com/CleverNucleus/PlayerEx/wiki). + + -### Contributors - - [gyular](https://github.com/gyular) - Korean translation. - - [Hertz](https://github.com/elhertz) - Spanish translation. - - [MrTYZzik](https://github.com/MrTYZzik) - Russian translation. - - [Orygeunik](https://github.com/Orygeunik) - Russian translation improvements. - - [NianGuu](https://github.com/NianGuu) - Simplified Chinese - - [sky_bai](https://github.com/a1640727878) - Simplified Chinese (legacy release) +_________________ + + + +![PlayerEX Screen at Level 5](https://cdn.modrinth.com/data/cached_images/a1932f9482b132e06b75717be8e060149b275b94.png) +The 4.*+ Player EX Screen
+ +### Preamble 📝 + +PlayerEX is a fundamentally rewritten mod based on the work of **CleverNucleus's [PlayerEx](https://modrinth.com/mod/playerex)**. The mod provides RPG-themed attributes to the game and a configurable leveling system. + +### Content 📦 + +With higher-level, highly configurable attribute modification provided by **[Data Attributes: Directors Cut](https://www.curseforge.com/minecraft/mc-mods/data-attributes-directors-cut)**, PlayerEX integrates skill and refundable points to spend through the non-intrusive, extendable, and modern screen, which can be activated by a hotkey (default is `-`). + +### Extras 🎬 + +- **[EXHud](https://modrinth.com/mod/exhud-directors-cut)**, which provides an optional, opinionated and highly-configurable UI complimentary for PlayerEX, and has compatibility with other mods, such as [**Thermoo**](https://modrinth.com/mod/thermoo), and [**AppleSkin**](https://modrinth.com/mod/appleskin). + +- **[RelicEX](https://modrinth.com/mod/relicex-directors-cut)**, which adds relics, tomes, different ways to obtain level, skill, and refund points. + +- **[WizardEX](https://modrinth.com/mod/wizardex-directors-cut)**, which provides a layer between this mod and **[Wizards](https://modrinth.com/mod/wizards)** and other mods that use **[Spell Power Attributes](https://modrinth.com/mod/spell-power)**. + +### Wiki 📑 + +To learn more about the mod, you can go **[here!](https://bareminimumstudios.github.io/Bare-Minimum-Docs/)** + +### Developers 💻 + +Ah, my favorite people. You will get some more information on how to mod PlayerEX once the release is stable. For now, know that you will be getting: + +- A way to implement attribute modification (and target any attribute you want and apply functions to them) into a registry. +- Override **any** registered attribute. +- Apply **any** attribute to **any** `LivingEntity` (primarily for the player). +- Attach to a screen using `owo-lib`. +- And much more... + +### For Forge Users 🪨 + +Howdy, I know you have all been **dying** for a forge release. This will come in due time. For now, the mod has been rewritten for fabric, but due to its compatible and improved nature, there is a way you can play it! + +*Refer to the **Usage Guide** on [**Sinytra Connector**](https://modrinth.com/mod/connector) to get started.* + +> There is no guarantee that it will work for Forge completely, and support **can not** be provided until an actual release of a forge mod is created. + +### Contributors 🆘 + +### The People Who Made This A Reality + +- The studio +- The wispforest team 💖 +- One guy's modpack +- Literally **YOU** +- And most importantly, **CleverNucleus** + +### Translators (legacy, `<=3.*`) + +- [gyular](https://github.com/gyular) - Korean translation. +- [Hertz](https://github.com/elhertz) - Spanish translation. +- [MrTYZzik](https://github.com/MrTYZzik) - Russian translation. +- [Orygeunik](https://github.com/Orygeunik) - Russian translation improvements. +- [NianGuu](https://github.com/NianGuu) - Simplified Chinese +- [sky_bai](https://github.com/a1640727878) - Simplified Chinese (older releases) + +### A Thanks To Our Sponsor + +--- + + + ++ Use code "BAREMINIMUM" to get 15% off your first month! +