Amethyst.Server 10.2.4

👁 .NET CI
👁 NuGet Downloads
👁 NuGet Version

Amethyst is a modern, high-performance API for Terraria servers, offering complete control and customization over every aspect of your server. Built for developers who demand flexibility and power.

📚 Read the Documentation

🛠️ Installation

Prerequisite: MongoDB must be installed on your machine. Download MongoDB.

1. Clone the repository:

   git clone https://github.com/realms-developers/Amethyst.API.git
   

2. Launch the server:

   • Windows:

     start.bat [args]
     

   • Linux:

     ./start.sh [args]
     

⚙️ Configuration

Run multiple server instances with isolated configurations using profiles.

• Isolated Data: Each profile stores configurations, plugins, and data in /data/<profile>, ensuring complete separation between server instances.
• Simplified Updates: Update core components, plugins, or modules once, and all profiles inherit the changes—no need to update each server individually.
• Reduced Clutter: Avoid scattered files by keeping all profile data organized in dedicated directories.

Amethyst dynamically loads configurations based on the profile name. For example, a profile named MyAwesomeServer uses the directory /data/MyAwesomeServer/.

To create and run a profile, use the -profile argument followed by your desired profile name:

• Windows:

  start.bat -profile MyAwesomeServer
  

• Linux:

  ./start.sh -profile MyAwesomeServer
  

The server will automatically generate the /data/<profile> directory and populate it with default configurations on first launch.

🧩 Extending Amethyst

Plugin vs Module

Development Guide

1. Install the template package:

   dotnet new install Amethyst.Templates
   

2. Create your extension:

   • Plugin:

     dotnet new aext-plugin -n MyPlugin
     

   • Module:

     dotnet new aext-module -n MyModule
     

3. Build and deploy:

   dotnet build -c Release
   

   Copy the output to the appropriate extensions folder.

4. Enable in-game:

   • Plugin:

     plugins setallow MyPlugin.dll
     plugins reload
     

   • Module:

     modules setallow MyModule.dll
     

You can also download standard modules and plugins from the Amethyst.Standard repository.

📜 Disclaimer

Terraria is a registered trademark of Re-Logic. This project is not affiliated with, sponsored by, or endorsed by Re-Logic. All Terraria assets remain property of their respective owners.