Installation Guide

First-time installations

Core Plugin

Modern SG releases are designed to be as intuitive as possible; simply drag and drop a Stargate .jar into your plugins folder.
Our flagship edition of Stargate is available for the Bukkit/Spigot/Paper ecosystem; downloads for it can be found here.

Having said that, we also support several other platforms; downloads for them can be found below:

Caution

This documentation is ONLY for the Stargate-Rewritten edition!
Other editions will likely have different features and may or may not be compatible.

Tip

Stargate-Rewritten is capable of importing data from all bukkit-compatible stargate plugins made since 2013.
If you have old data, try swapping out your stargate folder with a copy of your old one and seeing what happens!

ℹ️NOTE

Your old permissions (stargate.<>) will be handled where possible; it is, however, strongly advised to upgrade to the the new sg.<> permission system (found here).

Edition	Status	Supported MC Versions	Platform	Link
Stargate-Rewritten	🔵 ALPHA	1.17+	Bukkit/Spigot/Paper	Link
Stargate-Unwritten	⚫ PRE-ALPHA	1.20.4+	Forge, Fabric, Sponge, Minestom	Link
Stargate-Bukkit	🟡 FROZEN RELEASE	1.17-1.20.4	Bukkit/Spigot/Paper	Link
Stargate-ESR	🟡 EXTENDED SERVICE	<1.16.5	Bukkit/Spigot/Paper	Link
Stargate-Sponge	🟠 DEPRECATED	1.11-1.12.2	Sponge	Link
Stargate-hMod	🔴 END OF LIFE	Alpha v1.2.0_02 - Beta 1.1_02	Hmod	Link

Setup

Restart your server after installing the plugin; a config.yml file will appear in the "Stargate" folder of your plugins directory.
The default settings and permissions should suffice for most basic use-cases.

For more information about configuring stargate, see this.
For a list of permission nodes you can use to control which features users have access to, see this.

Databases

By default, StarGate will use a sqlite (.db) file to store its data.
If you are using bungee, such a file can support cross-server gates using a simplified protocol (u).

If you would like to make use of more complicated cross-server gates (i), you will need a relational database.
For more information about setting up such a database, see this guide on installing and using mysql.

Add-ons

Stargate's core adheres to a strict design philosophy; some potentially interesting features are not present in the core, and have instead been implemented in official modules. Additionally, over time, some developers have made their own addons within the stargate ecosystem.

A list of Modules and Addons for Stargate may be found here!

To install an addon/module, simply take the addon/module's jar and put it in your plugins folder.
The addon/module and Stargate should do the rest, but note that there may be some addon/module config files.