# Getting started

## 📥 How to install SlimeRanks

{% stepper %}
{% step %}

### Download

At first you need to download the newest version of SlimeRanks from [Modrinth](https://modrinth.com/plugin/slimeranks) or [Hangar](https://hangar.papermc.io/Lxca/SlimeRanks).
{% endstep %}

{% step %}

### Installation

Now you have to move the recently downloaded file into the servers' `plugins` folder.\
After that you need to restart the server to load the plugin.
{% endstep %}

{% step %}

### Configuration

That's it; you successfully installed SlimeRanks on your server. Now you're free to configure the plugin to your needs.
{% endstep %}
{% endstepper %}

## ⚙️ How to configure SlimeRanks

I've tried to make the usage and configuration of SlimeRanks as easy and as powerful as possible. So there are two primary methods to configure SlimeRanks ranks after your needs.

The first and easiest method is to use the in-game GUI to create and manage ranks.\
If you like using a GUI to configure plugins, I recommend reading the following article.

{% content-ref url="/pages/Yt43CoOREHxxiNFa16FA" %}
[Configure SlimeRanks (GUI)](/slimeventure-plugins/slimeranks/configure-slimeranks-gui.md)
{% endcontent-ref %}

If you prefer the manual configuration, I suggest you read the following article to configure ranks via the configuration file.

{% content-ref url="/pages/IDyVF0DwY3xTIbjiCHHD" %}
[ranks.yml](/slimeventure-plugins/slimeranks/configure-slimeranks-config/ranks.yml.md)
{% endcontent-ref %}


---

# 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://slimeventure.gitbook.io/slimeventure-plugins/slimeranks/getting-started.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.