-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
836a544
commit bd03e5c
Showing
1 changed file
with
104 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,112 @@ | ||
|  | ||
| [](https://github.com/PlayerEXDirectorsCut/playerex/blob/1.20.1/main/LICENSE) | ||
| [](https://github.com/PlayerEXDirectorsCut/playerex/stargazers) | ||
| [](https://github.com/PlayerEXDirectorsCut/playerex/forks) | ||
| [](https://github.com/PlayerEXDirectorsCut/playerex/issues) | ||
|
|
||
| [](https://playerexdirectorscut.github.io/Bare-Minimum-Docs/) | ||
|  | ||
|  | ||
| [](https://www.curseforge.com/minecraft/mc-mods/playerex-directors-cut) | ||
| [](https://modrinth.com/mod/playerex-directors-cut) | ||
| <p align="center"><b><i>Forge when?</i></b></p> | ||
|
|
||
| ### Preamble | ||
| </br> | ||
|
|
||
| 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). | ||
| <p align="center"> | ||
| <img src="https://img.shields.io/badge/MIT-MIT?style=for-the-badge&label=LICENCE&labelColor=582b11&color=a48350&link=https%3A%2F%2Fgithub.com%2FBareMinimumStudios%2Fplayerex%2Fblob%2F1.20.1%2Fmain%2FLICENSEe"> | ||
| <img src="https://img.shields.io/github/stars/BareMinimumStudios/playerex?style=for-the-badge&logo=github&color=faa526&link=https%3A%2F%2Fgithub.com%2FBareMinimumStudios%2Fplayerex%2Fstargazers"> | ||
| <img src="https://img.shields.io/github/forks/BareMinimumStudios/playerex?style=for-the-badge&logo=github&color=fa9256&link=https%3A%2F%2Fgithub.com%2FBareMinimumStudios%2Fplayerex%2Fforks"> | ||
| <img src="https://img.shields.io/github/issues/BareMinimumStudios/playerex?style=for-the-badge&logo=github&label=ISSUES&link=https%3A%2F%2Fgithub.com%2FBareMinimumStudios%2Fplayerex%2Fissues"> | ||
| </p> | ||
|
|
||
| Find the original mod [here!](https://modrinth.com/mod/playerex) | ||
| <p align="center"> | ||
| <img alt="fabric" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg"> | ||
| <img alt="quilt" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/quilt_vector.svg"> | ||
| </p> | ||
|
|
||
| ### Content | ||
| <p align="center"> | ||
| <img alt="forge" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/forge_vector.svg"> | ||
| </p> | ||
| <p align="center">(though more assembly is required, see further below)</p> | ||
|
|
||
| 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). | ||
| <p align="center"> | ||
| <a href="https://bareminimumstudios.github.io/Bare-Minimum-Docs/"> | ||
| <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/generic_vector.svg"> | ||
| </a> | ||
| <a href="https://github.com/BareMinimumStudios/playerex"> | ||
| <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/github_vector.svg"> | ||
| </a> | ||
| <img alt="java" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/java_vector.svg"> | ||
| <img alt="gradle" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/gradle_vector.svg"> | ||
| <a href="https://discord.gg/pcRw79hwey"> | ||
| <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg"> | ||
| </a> | ||
| </p> | ||
| </br> | ||
|
|
||
| ### 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) | ||
| _________________ | ||
|
|
||
| </br> | ||
|
|
||
|  | ||
| <p align="center"><i>The 4.*+ Player EX Screen</i></p> | ||
|
|
||
| ### 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 | ||
|
|
||
| --- | ||
|
|
||
| </br> | ||
|
|
||
| <p><img src="https://i.imgur.com/V38aMzY.png" alt="Sponsor Banner"/></p> | ||
| <p align="center"> | ||
| <i><b>Use code "BAREMINIMUM" to get 15% off your first month!</b></i> | ||
| </p> |