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

# Getting Started

{% stepper %}
{% step %}

### Download Tweaky

Make sure you have the latest version installed. You can download it at any of these links:

1. [Modrinth](https://modrinth.com/plugin/tweaky/versions)
2. [Spigot](https://www.spigotmc.org/resources/tweaky-60-tweaks.123654/)
3. [Paper](https://hangar.papermc.io/Scill/Tweaky)
4. [Github](https://github.com/ColinGrime/Tweaky/releases)
   {% endstep %}

{% step %}

### Restart Your Server

* After you have it downloaded, add the jar to your `/plugins` folder.
* Since this plugin has no dependencies, you can restart your server to activate it!
  {% endstep %}

{% step %}

### Enabling Tweaks

By default, all tweaks are <mark style="color:$danger;">**disabled**</mark>. Navigate over to the [Categories](/categories/mobs.md) section to view a description on all of them. Once you know which ones you like, enable it by:

1. The <mark style="color:$success;">**NEW**</mark> `/tweaky toggle` GUI. See the [Menus](/about/menus.md) section for more info.
2. Typing `/tweaky toggle <tweak_id>` with the ID associated with the tweak.
3. Manually enabling it via the `config.yml` file.
   {% endstep %}

{% step %}

### Viewing Tweaks (Admin)

* If you are using the `/tweaky toggle` command, you can easily view all available tweaks.
* Alternatively, you can use the old `/tweaky list` command to view all available tweaks.
  {% endstep %}

{% step %}

### Permissions

* You can optionally add permission nodes to tweaks.
* See the [Permissions](/about/permissions.md) section for more info.
  {% endstep %}

{% step %}

### Viewing Tweaks (Player)

* Players should know what tweaks are available to them!
* This can be done through the `/tweaks` menu to open up the Tweak Menu.
  * This only shows them the enabled tweaks they have access to.
    {% endstep %}
    {% endstepper %}

I really hope you enjoy and have a fun SMP! :)

***

{% hint style="info" %}
Some tweaks have extra features that can be enabled/configured. These can only be changed in the `config.yml` file. Make sure to do `/tweaky reload` after changing these!
{% endhint %}
