Player Persistence Mod

WARNING: This mod requires a configured PostgreSQL server!

This library is intended for Minecraft server developers aiming to provide continuous gameplay between server restarts and transitions between different worlds. It automatically saves and loads character states to a database, including inventories, ender chest contents, and coordinates, ensuring the preservation of game progress.

Key Features

• PostgreSQL Integration: The mod is designed to work with PostgreSQL, making it an ideal solution for large server networks and custom setups requiring reliable data storage.

• Inventory Preservation: Automatic backup of player inventory contents with full equipment and off-hand items ensures equipment integrity between gaming sessions.

• Coordinate Synchronization: Saving the exact character location and dimension data during server restarts and cross-server transitions allows players to continue the game from the same point where they stopped.

• Ender Chest Backup: Similar to inventory, saves and restores ender chest contents, protecting valuable items from loss.

• Optimization for Docker and Kubernetes: Easy configuration through environment variables _DB_URL, _DB_USER, and _DB_PASS. For coordinate synchronization between different server types, set the _SERVER_NODE variable with your server name.

Technical Details

The mod is created as a tool for server developers and does not add visible game elements. After integration into the server build and configuring the database connection, the library automatically handles player data preservation.

Compatibility

The library works on the Fabric API platform and is compatible with the latest versions of Minecraft. The modular architecture allows developers to adapt and expand functionality according to specific server requirements.

Missing a needed feature? Create a request on GitHub, and we'll consider implementing it.

Usage Instructions

Add the dependency to the project:

include("maven.modrinth:playerpersistence:0.0.2")?.let { modImplementation(it) }

Create a PlayerPersistence object:

var pp = PlayerPersistence()

Use the provided methods as you see fit. Happy coding!