Quickstart

Free library for Runith plugins.

RunithCore

All runith plugins depend on this core to function.

Download it here!

Default Configuration

# Recommended: gson for small servers,
# mongodb for large servers or mariadb if you can't use mongodb. (Mongodb is recommended for better performance and scalability)

# Available: mongodb, gson, mariadb and none
# none database always return null and don't save data
type: "gson"
context-prefix: "" # Use: prison, lobby, survival-og for separate data in the same database

mongodb:
  uri-enable: false
  uri: "mongodb+srv://test:[email protected]/?retryWrites=true&w=majority&appName=Test"

  user: "admin"
  password: "password"
  host: "localhost"
  port: 27017

  connect-timeout-seconds: 3
  read-timeout-seconds: 2

gson:
  path: "plugins/RunithCore/Gson-Database"

mariadb:
  # Basic connection settings
  host: "localhost"
  port: 3306
  database: "runith_db"
  user: "root"
  password: "password"

  # Connection pool settings (optional)
  pool:
    maximum-pool-size: 10
    minimum-idle: 2
    connection-timeout-ms: 30000
    idle-timeout-ms: 600000
    max-lifetime-ms: 1800000

We recommend using MongoDB for servers with a large number of users (+30), GSON for testing or few users, and none for testing (no data will be saved).