# Options

Quickly find the option you're looking for!

| Option                                                                                   |
| ---------------------------------------------------------------------------------------- |
| [Prefix](/adventure-studios/ultimate-pets/welcome/options.md#prefix)                     |
| [Permission](/adventure-studios/ultimate-pets/welcome/options.md#permission)             |
| [Admin Permission](/adventure-studios/ultimate-pets/welcome/options.md#admin-permission) |
| [Sound](/adventure-studios/ultimate-pets/welcome/options.md#sound)                       |
| [Buff toggle](/adventure-studios/ultimate-pets/welcome/options.md#buff-toggle)           |
| [Bonuses](/adventure-studios/ultimate-pets/welcome/options.md#bonuses)                   |

### Options

#### Prefix

You can change the prefix of the addon with this. Feel free to use hex codes and name it anything you wish.

```
# Prefix - We recommend you set this to your server's name. This will prefix most messages. Hex codes are available for 1.16+
	prefix: <##7289DA>Adventure Studios &7»
```

#### Permission

This is the permission required by users to be able to access the pets menu. You can change this to anything you want, but we recommend keeping it simple. Don't forget to change your ranks permissions if you change this!

```
# Permission - The permissions required to use certain commands/functions
	# Generic permission to access menu and manage your pet
	perm: ultimatepets.use
```

#### Admin Permission

This is the permission node for the administrative side of the plugin. Only give this to your senior staff members! It's used to despawn all pets.

```
# Admin Permission - Permission needed to utilize admin commands for managing pets server-wide
	adminperm: ultimatepets.admin
```

#### Sound

This is the sound played when someone opens the pets menu or clicks a button. Change this to a valid minecraft sound.

```
# Sound - The sound played when interacting with things
	# A valid sound list can be found here: http://www.theredengineer.com/1.9-playsound-list.html
	sound: block.note_block.pling
```

#### Buff Toggle

The pets in this pack give the player using them buffs. You can disable this by changing this option to false.

```
# Buff toggle - Select whether bonuses should be applied when pets are active
	# Set to a boolean; true or false
	buffs: true
```

#### Bonuses

Don't want the fox to give you swiftness? You can change this to any minecraft potion effect you like!

```
# Bonuses - The buff applied when a pet is active. Can be toggled off with the option above
	# A valid effect list can be found here: https://skripthub.net/docs/?id=2161
	bee: slow falling
	elephant: resistance
	squid: water breathing
	basketball: jump boost
	fox: swiftness
	penguin: haste
	hamburger: saturation
```


---

# 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:

```
GET https://adventurestudios.gitbook.io/adventure-studios/ultimate-pets/welcome/options.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.
