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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://tweaky.scill.me/about/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.