Player Persistence

Player Persistence Mod

WARNING: This mod is an API, it requires a functioning PostgreSQL Server and additional code to function! It does not work as standalone!

Overview: The Player Persistence mod is a lightweight library designed for Minecraft server developers who want to provide a seamless, persistent experience for players across server restarts and world transitions. This mod handles the automatic saving and loading of player inventory, Ender Chest contents, and positional data to a database, ensuring that players' states are preserved accurately.

Key Features:

• Optimized for Docker and Kubernetes Deployments: Change which DB to use with what user simply by setting the enviroment variables DB_URL DB_USER DB_PASS. To sync coordinates across multiple ServerTypes set the SERVER_NODE variable to the name of your Server.

• Inventory Persistence: Automatically save and load player inventories, including armor and off-hand items, to a database. This ensures that player items are consistent and safe across server sessions.

• Ender Chest Persistence: Similar to inventory persistence, this feature saves and loads the contents of players' Ender Chests, making sure that these valuable items are not lost.

• Player Position Syncing: Maintain the exact player position and dimension data across server restarts or even cross-server transitions, allowing players to continue their journey exactly where they left off.

• PostgreSQL Database Integration: The mod is built to work with PostgreSQL databases, making it ideal for large server networks or custom server setups that require persistent data storage.

Usage

This mod is intended as a backend library for server developers and does not add any direct gameplay features. To use the mod, simply integrate it into your server's mod setup, configure the database connection, and let the mod handle player data persistence automatically.

Compatibility

The mod is designed to work with Fabric API and is compatible with the latest version of Minecraft. It is also modular and can be customized or extended by developers to fit specific server needs.

How-To-Use

• Add the dependency to your project: modApi("maven.modrinth:player-persistence:VERSION")?.let { include(it)}
• Create a PlayerPersistence Object e.g var pp = PlayerPersistence()
• Use the methods as needed

Missing something?

If you're missing some feature please open a issue on GitHub and we'll see to it.