🚀 Getting Started

Follow this guide to get Tyche up and running on your server in less than 5 minutes.

1. Prerequisites

Before installing, ensure your server meets the following requirements:

• Java Version: Java 11 or higher (Recommended: Java 17 or 21).

• Server Version: Spigot, Paper, or any fork from 1.8.8 to 1.21.x.

• Database: A valid MongoDB Connection URI.

---

2. Installation Steps

1. Download: Grab the latest tyche-1.x.jar from your purchase area.

2. Upload: Place the jar file into your server's /plugins folder.

3. Restart: Restart your server to generate the configuration files.

4. Configure: Open /plugins/Tyche/config.yml.

---

3. Activating your License

Tyche is protected by the Skiron Security API. To enable the plugin, you must enter your unique license key.

{% hint style="danger" %} Important: Your license key is locked to your server's Hardware ID (HWID) upon first use. If you plan on moving servers, please contact support for a reset. {% endhint %}

1. Locate the license: field in your config.yml.

2. Paste your key exactly as it appears in your purchase email.

3. Save the file and run /itemflip reload or restart the server.

---

4. Database Setup

Tyche uses MongoDB for high-speed data handling. If you don't have a database, you can get a free one at MongoDB Atlas.

YAML

mongodb:
  uri: "mongodb+srv://admin:[email protected]/tyche_db"
  database: "tyche_db"

---

5. Verification

Once the plugin is set up, look for this message in your server console: [Tyche] Licensed successfully to {YourName}! [Tyche] Successfully connected to MongoDB.

If you see these messages, the Goddess of Luck is ready! You can now use /itemflip in-game.