![logo](https://i.imgur.com/9gWmnGo.png)

# Welcome to Peaches!

This bot is built from the ground up with programmability and customization in mind. It allows you and your server admins to create and modify your own slash commands or triggers that activate during certain guild events. The power of the bot comes from its flexible scripting language that lets you easily post messages, create embeds, add buttons, send DMs, create roles, store data and more! If you’ve ever used YAGPDB CCs, this will be a very familiar experience.

# Getting Started

After you invite the bot, the easiest place to start is with the `/help` command. It will provide links to both the official support server as well as the official documentation that has a series of tutorials to walk you through some of the bot’s main features.

# Scripting Language

The bot’s simple yet powerful scripting language provides a large number of features that you can make use of. This list is growing rapidly, but these are some of the big ones:

### Messages

- Respond publicly and privately to slash commands
- Post messages in channels with text, embeds, and buttons
- Send DM to user

### Components

- Add buttons to your messages
- React to button clicks 
- Add link buttons to direct your members

### Roles

- Give and take roles from members
- Edit role names and colors
- Create and delete roles
- Reorder role hierarchy

### Channels (Beta)

- Create and delete channels
- Edit channel name and topic
- Edit channel slowmode
- Edit or set channel permissions

### Moderation

- Ban or unban members with reason
- Mute or unmute members with reason

### Database

- Store custom data that your scripts can reference later
- Easily modify or delete existing data
- Atomic increment for adding counters

### Triggers

In addition to slash commands, scripts can be attached to triggers. Here are the currently supported ones:

- User join and leave
- Message created
- Member muted or unmuted
- Member banned or unbanned
- Channel created or deleted
- Thread created or deleted
- Button interacted with
- Functions that can be triggered by other scripts

# Commands

These are the bot’s primary commands:

`/create-cmd` : create a new slash command
`/delete-cmd` : delete an existing slash command
`/create-trigger` : create a new guild event trigger
`/delete-trigger` : delete existing guild event trigger
`/set-source` : modify the source of an existing slash command or trigger
`/view-source` : views the source of an existing slash command or trigger
`/view-triggers` : allows you to see a list of currently-active triggers for a certain guild event type

These are the bot’s utility/fun commands:

`/takebreak` : allows your server members to temporarily mute themselves for up to 1 day
`/trivia` : starts a game of trivia
`/trivia-leaderboard` : view the leaderboard for your guild
`/wordie` : starts a game of wordie - a multiplayer word puzzle game
`/wordie-leaderboard` : view the wordie leaderboard for your guild
`/artprompt` : Selects a random art prompt from a list of over 1000 total prompts spread out over 8 art categories
`/storyprompt`: Selects a random story prompt from a list of over 1000 total prompts spread out over 4 story categories

# Roadmap

Peaches is under active development with new features being added every week. These are the ones that will be added very soon:

- Ability to manage reactions
- New trigger types for different guild events
- Expanded database capabilities

# Support Peaches

Any support is greatly appreciated! You can help by voting here or by joining the official Discord support server listed on this page.


Peaches

Customize your guild with slash commands, games and utilities! Supports trivia, wordie, buttons, threads, roles, art+story prompts and more.

Stemmen voor Peaches