# Quickstart

### RunithCore

All runith plugins depend on this core to function.

{% hint style="success" %}
Download it [here](https://github.com/RunithMC/maven/releases/tag/core)!
{% endhint %}

{% code title="Default Configuration" overflow="wrap" expandable="true" %}

```yml
# 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:test@test.rsojstp.mongodb.net/?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


```

{% endcode %}

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).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://runith.gitbook.io/runith/getting-started/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.