Installation
Download Identica and its providers, put the jars in place, and start the proxy once.
Identica runs on a Velocity, BungeeCord or Waterfall proxy. This page installs it with the two official providers, Credential and Premium, on one proxy. When it is done, continue with First configuration.
To run Identica on several proxies that share their players, install it on each proxy as described here, then follow Running several proxies.
Before you start
- a Velocity, BungeeCord or Waterfall proxy running on Java 21 or newer
- at least one backend server for players who are logging in, and the servers they play on afterwards
- internet access from the proxy on the first start, when Identica downloads its libraries
All features of Identica, such as two-factor verification, are part of the plugin. Nothing else needs to be installed for them; they are turned on in the configuration.
Install Identica
Download Identica and its providers
Use GitHub releases when you want stable published versions.
Download flow:
- Open the releases page.
- Open the release version you want to install.
- Expand the release assets if they are collapsed.
- Choose one installation style:
- download
Identica-BUNDLE-<version>.jarfor one jar that runs on every supported proxy - download
Identica-PLATFORMS-<version>.zipfor one jar per proxy instead - also download
Identica-Credential-<version>.jar - also download
Identica-Premium-<version>.jar
Put the jars in place
Identica comes in two forms; use one of them:
Identica-BUNDLE-<version>.jarruns on every supported proxy.Identica-PLATFORMS-<version>.zipholds one jar per proxy:Identica-VELOCITY-<version>.jarandIdentica-BUNGEECORD-<version>.jar.
The Identica jar goes into the proxy's plugins/ directory. The provider jars go into the providers/ directory inside Identica's data directory, which you create yourself before the first start. Never put a provider jar directly into plugins/.
With the jar for your proxy instead of the bundle, Identica-VELOCITY-<version>.jar takes the place of Identica-BUNDLE-<version>.jar.
Start the proxy once
Start the proxy so Identica can create its configuration files. You finish the setup afterwards, so the first start only needs to complete.
First startup can look stuck
On the first startup, Identica downloads its required libraries, among them the driver of the configured database, so the server may not print anything new for a while and can feel stuck even though the download is still in progress. This can be fast or slow depending on the internet connection, and the server must have internet access and be able to reach Cloudflare-protected sites. The first startup after switching to another database type downloads that database's driver the same way.
Once the startup has finished, Identica prints its banner in the console.
A failed startup closes the proxy to players
If Identica cannot finish its startup, for example because a configuration file is invalid or a required library could not be downloaded, the proxy keeps running but Identica refuses every connection with the game's own message for unavailable authentication servers, shown in each player's language. Nobody reaches a backend server without authentication. Read the error in the proxy console, fix its cause, and restart the proxy.
Identica's data directory is plugins/identica/. After the first start it holds:
The empty file type=YAML makes Identica write its files as YAML. Rename it to type=JSON for JSON before you change any setting; Identica does not convert files that already exist. Configuration describes every file.
Stop the proxy before you edit the files.
Configure the basics
Identica's defaults name example servers and hostnames that your network does not have. First configuration walks through what to change before players join.