Skip to content

EinJOJO/polarrealms

Repository files navigation

Polar Realms

Polar Realms - WIP 🏝️

Done:
Host-Loader, API-Strucutre, Networkwide Event System, Polar integration, SSH-File-Storage, 
Players, Properties, Project strucutre.
 
Progress: [##### ##... ..... .....] 35%

- Database, RPC-Loader, State Management, World Data, Templates, Upgrades...

Polar Realms is a work-in-progress world management plugin for Paper Minecraft servers. While initially designed for use on wandoria.net, this plugin is built to be highly extendable and adaptable to other server environments. Its primary goal is to provide a robust system for managing world data and properties across multiple servers.

Highlights

🛠️ Features

This plugin aims to provide a comprehensive set of features for managing world data. The core functionality is being developed with multi-server compatibility and a flexible property system in mind.

Multi-Server Compatibility

This feature allows the plugin to handle world data seamlessly across multiple interconnected servers.

  • SFTP/SSH Storage: Utilizes the PolarPaper format to store world data in compact byte-files, enabling efficient and reliable storage and retrieval across different servers.

  • PostgreSQL Storage: Planned support for a PostgreSQL database to provide an alternative, more scalable storage solution for world data.

Property System

This system provides a structured way to define and manage custom properties for different worlds. This will be useful when writing plugins that want to read and write realm-related data.

🧩 Dependencies

This project relies on several key dependencies to function correctly.

  • PolarPaper: A crucial dependency that provides a very small world format for efficient data storage. You can find more information on their GitHub page.

  • Redis: Used for high-speed, in-memory data caching => State management and world data retrieval?

  • PostgreSQL: The planned database solution for scalable world data storage.

🤝 Contributing

Contributions are welcome! Please feel free to open a pull request or submit an issue to report bugs or suggest new features.

📚 Documentation

The official documentation for this project is being developed using Writerside. It is not hosted yet and has not been written yet.


Ideas

  • LuckPerms Context Support
  • Placeholder API Support

About

Realm System

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published