|
1 | 1 | # PlayerCorpses |
2 | 2 |
|
3 | | -Add player corpses to your server. |
| 3 | +PlayerCorpses is a plugin for Minecraft that allows you to create corpses, adding an immersive and interactive experience for players. When a player dies, they leave behind an NPC representing their corpse that can be interacted with to retreive items. |
4 | 4 |
|
5 | | -## Requirements |
| 5 | +## Features |
6 | 6 |
|
7 | | -Paper & Folia 1.21.4 with Java 21 (or higher) is required. Plugin should also work on Paper forks. |
8 | | -Spigot is **not** supported. |
| 7 | +- **Player Corpses**: When a player dies, a corpse NPC is created at the death location, retaining the player's inventory. |
| 8 | +- **Npc Interaction**: Players can interact with corpses to access the items stored in their inventory. |
| 9 | +- **Break Corpses**: Players can break a corpse NPC, dropping its contents at the location of the corpse. |
| 10 | +- **Customizable Locale Support**: Fully configurable locale system to allow translation and customization of in-game messages. |
| 11 | +- **NPC Integration**: Works with the **FancyNPCs** plugin to create detailed and interactive NPCs representing fallen players. |
| 12 | +- **Customizable Menus**: The plugin features customizable menus for interacting with corpses and their items. |
| 13 | + |
| 14 | +## Installation |
| 15 | + |
| 16 | +1. **Download the plugin**: Download the latest version of PlayerCorpses and place it in the `plugins` directory of your server. |
| 17 | +2. **Install FancyNPCs Plugin**: To enable NPC functionality, download and install the **[FancyNPCs](https://modrinth.com/plugin/fancynpcs)** plugin. |
| 18 | +3. **Configure Locale**: If you wish to use a language other than English or Russian, configure the plugin’s locale files found in the `locale` folder. |
| 19 | +4. **Restart your server**: After installation and configuration, restart your server to apply the changes. |
| 20 | + |
| 21 | +## Configuration |
| 22 | + |
| 23 | +PlayerCorpses comes with configurable messages and settings to allow you to tailor the plugin to your server's needs. |
| 24 | + |
| 25 | +- **Locale Configuration**: The plugin supports multiple languages. Locale files can be found in the `locale` folder. |
| 26 | +- **Custom Messages**: The plugin uses the **MiniMessage** format for text formatting. You can find more information on how to format messages in the [MiniMessage documentation](https://docs.advntr.dev/minimessage/format). |
| 27 | + |
| 28 | + |
| 29 | +## Commands |
| 30 | + |
| 31 | +Currently, there are no commands provided by this plugin. Interaction is done through the GUI menus generated when interacting with a corpse NPC. However, as the plugin evolves, additional commands may be added in the future, such as reloading the plugin, setting skins for corpse NPCs, and more. |
| 32 | + |
| 33 | +## Usage |
| 34 | + |
| 35 | +### Interacting with Corpses |
| 36 | + |
| 37 | +- When a player dies, a corpse NPC will be created at the location of death. |
| 38 | +- Players can click on the corpse NPC to open a menu with the option to break the corpse and pick up items. |
| 39 | + |
| 40 | +## Support |
| 41 | + |
| 42 | +If you encounter any issues or have questions, feel free to reach out to the plugin developers via [Discord](https://discord.gg/vsUB7FsRu4). |
| 43 | + |
| 44 | +## Changelog |
| 45 | + |
| 46 | +### 1.0.0 - First Release |
| 47 | +- Initial release of PlayerCorpses. |
| 48 | + |
| 49 | +## License |
| 50 | + |
| 51 | +This plugin is provided "as-is", without any warranty. You may use it under the terms of the [license](LICENSE). |
0 commit comments