Installation

Requirements

Requirement	Version
Java	25+
Paper / Spigot	1.21+
MariaDB	10.6+ recommended
Redis	6+
AstralCore	latest
PacketEvents	2.11.1+

Server Installation

Download AstralSync-3.0-SNAPSHOT.jar from the release repository.
Place the JAR in your server's plugins/ directory.
Start the server once — AstralSync will generate its configuration files under plugins/AstralSync/.
Stop the server.
Edit plugins/AstralSync/database.properties with your MariaDB credentials (see Database Configuration).
Edit plugins/AstralSync/config.yml as needed (see Configuration).
Start the server. AstralSync will create the snapshots table automatically on first run.

Maven Dependency (for plugin developers)

If you are building a plugin that integrates with AstralSync, add the following to your pom.xml:

<repositories>
    <repository>
        <id>astralrealms-public</id>
        <url>https://maven.astralrealms.fr/repository/maven-public/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.astralrealms</groupId>
        <artifactId>sync</artifactId>
        <version>3.0-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Declare AstralSync as a dependency in your plugin.yml:

depend:
  - AstralSync

Or as a soft dependency if your plugin works without it:

softdepend:
  - AstralSync

24 April 2026