# Home Sapoto is a feature-rich, highly optimizable, free ticket bot. ## Preparation Thanks for considering Sapoto as the Ticket Bot for your guild! It is very important that you read these docs thoroughly so you can fully utilize it's abilities. {% hint style="info" %} To invite Sapoto to a guild, you will need the `Manage Guild` permission. {% endhint %} You can invite Sapoto with [this link](https://discordapp.com/oauth2/authorize?client_id=517228615042072576\&permissions=8\&scope=bot). If you need help, don't hesitate to join our [Discord server](https://discord.sycer.dev/) {% hint style="warning" %} For Sapoto to work correctly, it needs the following permissions: * `Read Messages` * `Read Message History` * `Send Messages` * `Embed Links` * `Manage Channels` * `Manage Roles` The link above grants `Administrator.` {% endhint %} That's it for the initial setup! Feel free to click the button below to continue to the configuration. # Quickstart Setup Sapoto within seconds. To make things convenient, when invited with the correct permissions, Sapoto will automatically setup the Support Team role, ticket category and ticket log. All you have to do is invite Sapoto to your server with [this](https://discordapp.com/api/oauth2/authorize?client_id=517228615042072576\&permissions=8\&scope=bot) link and the whole setup will be done for you. [![Discord Bots](https://discordbots.org/api/widget/517228615042072576.svg)](https://discordbots.org/bot/517228615042072576) # New Ticket Creating a new ticket is as simple as: ``` -new [...subject] ``` {% hint style="info" %} The `subject` is optional. {% endhint %} When creating a new ticket, that will allow all Server Administrators, Support Team members, and the user to communicate withing the newly created channel. **Everything message you send in a ticket is logged.** Why? Go to the next page to find out. # Closing a Ticket So, you've resolved your problem? Good! Now, you can close your ticket: ``` -close ``` Remember what I said about logging on the last page? When you close the ticket, it will message you a transcript of the ticket and to the server's ticket log. In the case that you ever need to refer to the conversation, you can download the transcript. If you want a transcript of the ticket and you're on the Support Team, you can use the `ticket` command with the `--log` flag. More info on that [here](/other/ticket-information). # Ticket Category Sapoto **requires** all tickets to be in a specified category for both logging purposes and help keep the server clutter to a minimum. You must have the permission `Manage Guild` to use this command. It as simple as: ``` -set-category <...category> ``` {% hint style="info" %} You can put in the category ID, name or even the partial-name. {% endhint %} # Ticket Log Sapoto keeps a detailed log of all opened and closed tickets, who closed them, and messages sent. A ticket log is **required** for a user to open a ticket. You must have the permission `Manage Guild` to use this command. ```http -set-log <...channel> ``` {% hint style="info" %} You can supply the channel's ID, name or even partial-name. {% endhint %} # Maximum Tickets per User To stop users from spamming ticket-creation, there is a maximum tickets per user in place. The default is `1` but can easily be changed with the `set-max` command. ``` -set-max <1-10> ``` # Change Prefix You don't like the default prefix `b?`? No worries! You can change the prefix to whatever you want! ``` -set-prefix * ``` {% hint style="info" %} The prefix must be shorter than 8 characters and contain no spaces. {% endhint %} # Support Team It is **required** for there to be a configured Support Team role. This can be any role you want! Having this role grants users the ability to view, respond to and close tickets. ``` -set-support <...role> ``` {% hint style="info" %} You can supply the role ID, name, or partial name. Role names can have spaces! {% endhint %} # Blacklist To blacklist a user from making tickets, simply use the `blacklist` command! ``` -blacklist ``` For the user parameter, you can supply an id, mention, username, or partial username! # Welcome Channel A welcome channel can quickly and efficiently alert new members of the server rules, where to make tickets, etc. To set the welcome message, simply supply your first argument as a channel and the rest being the message you want to send. You can include any one of the variables listed below. ``` -welcome <...message> ``` The welcome messages has many different variables you can use such as the username, tag, server name, etc. ``` -set-welcome-msg <...message> Example: -welcome #welcome Hey {user}, welcome to {server}! welcome #welcome Hey {user.tag}, welcome to {server}! We now have {server.size} members. welcome welcome {user} just joined the server! welcome #join-log [NEW MEMBER]: {user.tag} ({user.id}) welcome --off Variables • {user} - Mention the new member • {user.discriminator} - The member's discriminator (Fyko#0001) • {user.discrim} • {user.tag} - The member's tag (Fyko#0001) • {user.id} - The member's ID (188242504670380033) • {server} - The server's name • {server.name} • {server.id}- The server's ID () •{server.owner}- Extends all the same items fromuserabove. •{server.size}- The server's member count ``` If you would like to suggest more replacements, join our [support server](https://discord.sycer.dev/). # Welcome DM You can also set a welcome DM to send to new members upon joining. You can use the same variables as listed in the [Welcome Channel](/member-join-configuration/welcome-channel). ``` -welcome-dm <...message> ``` # New Ticket Message You can even change the message sent when a new ticket is created! ``` -set-msg <...message> ``` {% hint style="info" %} You can `Shift + Enter` to go down a line. {% endhint %} ![](https://3707384885-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LbMUC_d3mrGrnhrnQ3G%2F-LcUy7eTN1Mo1Ak1KGiP%2F-LcV-VG8GjTWQIe1Dj7j%2Fimage.png?alt=media\&token=54d6e662-f1e8-429e-8a97-02960e8f9e73) # Ticket Information If you want more information on a ticket, you can use the `ticket` command. It responds with the user that opened it, the subject, when it was created, if it's open or closed and how many messages were logged. ``` -ticket ```
**PREMIUM:** In the case that you want a log of the specified ticket, you can do: ``` b?ticket --log ```
# Premium Premium on Sapoto is now **100% free**! All you have to do is vote for us on [DiscordBots.org](https://discordbots.org/bot/517228615042072576/). Voting will instantly give you premium benefits in 1 server for 24 hours. There is no maximum on how many times you can vote. (you can essentially get premium indefinitely if you vote once a day) We still offer the **Business** (custom branded) **Class** but at a higher rate of $15 a month and $50 lifetime. If you would like to purchase the business class, please join our [Discord server](https://discord.sycer.dev/). # FAQ #### Support Server You can join our support server with [this ](https://fyko.net/discord)link! When you join, please go to #support and mention you're using Sapoto as we provide support for over 5 different products. # 2.1.0 Addition of ticket updates, reaction-to-open panels, custom timezone and more! ## Ticket Updates This update introduces ticket updates, a system that will alert the ticket opener if they've not responded to a ticket after 5 minutes. To enable the updates system, simply run `-updates`. ![Toggling updates](https://3707384885-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LbMUC_d3mrGrnhrnQ3G%2F-Lw5Uqgc4AEvJQSjpf4K%2F-Lw5mFU5yYCaBHjtVCoJ%2Fimage.png?alt=media\&token=e9522398-e955-4e33-bdfe-6481ef75d09d) ![Update notification](https://3707384885-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LbMUC_d3mrGrnhrnQ3G%2F-Lw5Uqgc4AEvJQSjpf4K%2F-Lw5mrCZSFZWzL1vWVzI%2Fimage.png?alt=media\&token=0e8ac0e8-f213-4bf8-b0a3-efbc3c2407f6) ## Ticket Reaction Panels This update also introduces the ability to make a ticket panel from any message with any reaction emoji. It's as simple as `-panel create #channel messageID :emoji:`. ![Panel create command usage](https://3707384885-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LbMUC_d3mrGrnhrnQ3G%2F-Lw5Uqgc4AEvJQSjpf4K%2F-Lw5nC-iaFy5r-Ykxpta%2Fimage.png?alt=media\&token=6fc62cc8-b7b0-4882-87ce-217328139d83) ![Ticket panel](https://3707384885-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LbMUC_d3mrGrnhrnQ3G%2F-Lw5Uqgc4AEvJQSjpf4K%2F-Lw5nILiJJul8JYUjpXo%2Fimage.png?alt=media\&token=c6bfd736-4b13-4138-b03e-8b3af9d484e6) ## Custom Timezone This update adds support for the setting of a custom timezone for logging and future implementation. {% hint style="info" %} Only time zones from [this ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)page are permitted. {% endhint %} ![Setting of timezone](https://3707384885-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LbMUC_d3mrGrnhrnQ3G%2F-Lw5Uqgc4AEvJQSjpf4K%2F-Lw5pXPuif2-8PlYqyqp%2Fimage.png?alt=media\&token=480fe015-d049-476f-a28f-02800df1d450) ## Other * Made the `help`command prettier * Made the `stats` command prettier * Fixed a bit-field error with the `invite` command * Gave Sapoto a festive Santa hat