> For the complete documentation index, see [llms.txt](https://slimeventure.gitbook.io/slimeventure-plugins/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://slimeventure.gitbook.io/slimeventure-plugins/slimeranks/getting-started.md).

# 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 %}