# Getting Started A getting-started guide that will help you find your way around Soundbort. ![](/files/-MggUYA9lo6U1MItQFsu) So you've chosen Soundbort. I hope you like your time with the bot! Soundbort is a custom soundboard bot for Discord. It's supposed to be as user-friendly as Discord allows it. Help making it better and more user-friendly is always appreciated. If you have improvements, check out the [Contributing ](/guide/contributing)page. **But first read this guide.** ## Basics Soundbort offers three different collections of audio samples, *called soundboards*. * **The standard soundboard**, that's the same for everyone and a starting point if you haven't added your own samples yet * **Server soundboards**, that the moderators of a Discord server manage and all members of that server can play any sample of that soundboard * **And personal aka. user soundboards**, that are tied to a discord user and allows them to take their sound samples with them across servers. If you're a server moderator and are interested in how to restrict modification to your server's soundboard, check out the [Server Moderation Guide ](/guide/server-guide)page. # First Steps What do I do first? You've just added Soundbort to your server. What next? ### Playing samples Just join a voice channel and type `/list`. You will see a list standard samples as **clickable buttons**. Go ahead and press one!
Type /list to see all available samples.
Soundbort should've joined you in your voice channel and played a short audio meme. Try another, this time it will be faster, because it doesn't have to join the voice channel first. You can also make Soundbort join your voice channel without playing anything by typing `/join` and you can make it leave by typing `/leave`. ### Adding your own samples You like where this is going? Great! Then let's upload some of your own samples! Type `/upload`, write down a name. Now either click on the "+2 more" and select "audio-file" or hit `TAB` after inputting the name. Grab yourself an audio file you might have laying around and drag it on the drag-and-drop area. *All common audio formats should be supported*. Now just execute the command with `ENTER`. ![Click on "+2 more" or press TAB after writing the name to upload a file right through the command.](/files/7p90ecC5HToM34k480bp) Alternatively you can upload a file into chat and execute the command afterwards. The file doesn't have to be uploaded by you for Soundbort to use it. ![Command for adding an audio sample to your soundboard.](/files/X7asilIVgmGix6hWdAsr) {% hint style="info" %} Be aware of the current upload limitations. You can view them on the [Limitations ](/guide/limitations)page. {% endhint %} If all went well, Soundboard should tell you it was "successfully added". {% hint style="warning" %} If you've encountered problems uploading your sample and Soundbort wasn't of much help resolving those issues, head over to [the Github](https://github.com/lonelesscodes/soundbort) and check for any already existing issues or open [a new issue](https://github.com/lonelesscodes/soundbort/issues). {% endhint %} Now you have added your first sample. Click the **"Play" button** to play it back. Type `/list` again to see it pop up in the list. {% hint style="info" %} By default `/upload` always adds samples to your personal soundboard. If you're interested in adding samples to your server soundboard, check out the next page [Server Guide](/guide/server-guide). {% endhint %} ### Removing samples from your soundboard If you don't like something about your sample or want to make room for more, you can click the **delete button** below the sample info.
Sample info with delete button.
Alternatively, if the sample info was deleted or you don't want to find it, you can type `/delete` and provide the name of the sample. The command will give you a list of matching samples that you can delete and in which soundboard they are in. ![Command to remove a sample from your soundboard.](/files/NdAEBSXlZEtG7VId8KJ4) If all went well, Soundboard should tell you it was removed and from which soundboard. ### Get more soundboard slots By default each user and server gets 10 slots they can fill with samples. To get more slots, users can upvote the bot on [Top.GG](https://top.gg/bot/868296331234521099/vote) once every 12 hours. On weekends you even get two slots per vote! You can also get the link to the bot page by typing `/vote`. Those **links are also personalised**, that means other users can click these links to give *YOU* soundboard slots. When the command is executed in a server, this also includes a link to give the server soundboard slots. ![Using the vote command.](/files/R0mS3tNQwNfp9xmtbwcN) ![Result of executing the vote command in a server.](/files/Fi2kSOiwgAhsn6HmHkF2) # Server Guide How do I change modification access of my server's soundboard? ### Setting permissions By default, the actions (*commands or buttons*) to add or remove samples from the server soundboard, or to use the `/config` command, can only be used by **members with the Administrator permissions**. To set your own permissions for these, Discord now has a way for server admins to set permissions for a command themselves with finer control over who can use what commands where. {% hint style="info" %} Permissions to alter the server soundboard will be based on the permissions you set for the `/config` command. This means you only need to set permissions in one place and they will apply to all administrative actions within Soundbort by default. {% endhint %} **This is how you do it:** {% embed url="" %} A video showcasing how to set permissions for the /config command {% endembed %} {% hint style="info" %} To change any permissions users must have the **"Manage Server" permission**! To **allow/disallow a role** for a specific command, the user must have the permissions to manage the role they want to allow/disallow. To **restrict a command to a specific channel(s)** the user must have the permissions to manage the channel they want to restrict. {% endhint %} That's it, you've now disallowed any non-moderator modification of the server's soundboard. :tada: ### Adding samples to your server soundboard By default `/upload` always adds samples to your personal soundboard. To add samples to your server soundboard type `/upload name:the sample name [TAB] to:` and choose "*Upload into server soundboard for every member to use.*". ![Add samples to your server soundboard.](/files/icaEQJkPpmI9o4DWx9Oh) Everything else stays the same. You just need to add the `to: server` to your command. {% hint style="info" %} You can only add samples to your server soundboard if you have permissions to use the `/config` command! {% endhint %} ### Removing samples from your server's soundboard This is exactly the same as in [First Steps](/guide/first-steps#removing-samples-from-your-soundboard). If you execute the command and you have the permissions for the server soundboard, the command will be deleted permanently. ![Delete command with a sample name suggestion for a server sample.](/files/bpPjzJU59x1VE6n6znxO) If the sample exists in both your user and server soundboard it will just ask you where you want to delete it from. ![Delete command choice wether to delete the sample from the user or server soundboard.](/files/eluN1R33sD9Y2js7vPhe) {% hint style="info" %} You can only remove samples from your server soundboard with the previously [set permissions](#setting-permissions) for the `/config` command. {% endhint %} ### Showing a list of all server samples To make Soundbort only show the server soundboard, type `/list from` and choose "*Output this server's soundboard only.*". ![Command for showing only the server soundboard.](/files/W8G42B3foalh1XmMsuur) ### Additional tips #### Channel with all server samples If you have a bigger community I recommend setting up a channel for the list of server samples, or pinning the response to a bot channel. This way users can quickly find and play the samples. ![Setup of a channel which shows the server's soundboard.](/files/-Mgjj5B7NRV8_KtWro_K) #### Bot command channel Discord allows commands to be restricted to specific channels only. The commands will not be available in other channels. It's great to keep other channels from being cluttered with commands. Like in [Setting Permissions](#setting-permissions), go to Server Settings -> Integrations -> Soundbort and set it up something like this: ![Setup of permissions that only allows commands in #bot-spam](/files/RA5HcWe6WpNpfoEzAxl4) # Limitations Soundbort's limitations regarding file size and soundboard sizes. Discord sets some limitations on how large a soundboard can be right now. Then some other limitations must be set by Soundbort to not run out of space too soon and keep providing this service. These are: | Maximum samples in a soundboard | 10 default (up to 25 by upvoting the bot on [top.gg](https://top.gg/bot/868296331234521099)) | | ------------------------------- | -------------------------------------------------------------------------------------------- | | Maximum sample length | 30 seconds default (longer soon) | | Maximum sample file size | 8 MB | | Maximum sample name length | 30 characters | {% hint style="info" %} These limits are subject to change, but if you have taken advantage of the limits, **you don't need to worry that your samples will be removed**. {% endhint %} # FAQ Frequently asked questions This page will be slowly populated over time as people have asked more questions. Visit the [Contributing ](/guide/contributing)page to find out where you can ask questions and get help. # Contributing Helping out or finding help. Soundbort is an open source project. You can help development, fix bugs and suggest new features. Or you can just ask questions and tell us about bugs. Soundbort has a staging bot with all new features and bug fixes before they become stable and are added to a new release. You can [add it here](https://discord.com/api/oauth2/authorize?client_id=869715767497740378\&permissions=2150943808\&scope=applications.commands%20bot). You can either just enjoy new features early or - what's really appreciated - help out when you find a bug and tell us about it. **Ask a question**: [Create an issue](https://github.com/Soundbort/Soundbort/issues/new?assignees=\&labels=question\&template=question.md\&title=%5B+Question+%5D+%3CReplace+this+with+a+short+description%3E). **Report a bug**: [Create an issue](https://github.com/Soundbort/Soundbort/issues/new?assignees=\&labels=bug\&template=bug_report.md\&title=%5B+Bug+%5D+%3CReplace+this+with+a+short+description%3E). **Make a suggestion**: [Create an issue](https://github.com/Soundbort/Soundbort/issues/new?assignees=\&labels=enhancement\&template=suggesting.md\&title=%5B+Enhancement+%5D+%3CReplace+this+with+a+short+description%3E). **Request a feature**: [Create an issue](https://github.com/Soundbort/Soundbort/issues/new?assignees=\&labels=feature+request\&template=feature_request.md\&title=%5B+Feature+Req.+%5D+%3CReplace+this+with+a+short+description%3E). ### Developing for Soundbort A full guide on how to contribute to development can be found on [Github](https://github.com/Soundbort/Soundbort). # Privacy Soundbort only collects a minimum amount of data it needs to be able to work. Mostly only IDs and no other metadata like names, avatars, etc. When those users, servers, roles, channels, messages, etc. are deleted from Discord, the IDs are of no more use. ### **What discord data do you store?** User IDs, Server IDs, Role IDs, Channel IDs, Message IDs, Interaction IDs, Attachment files ### **For what purpose(s) do you store the information you collect?** Setting an admin role for admin commands: **Role IDs** and **Server IDs** (only IDs, no names, creation dates, etc.) To keep track of the replies to interactions and later send follow-up messages: **Interaction IDs**, **Server IDs**, **Channel IDs**, **Message IDs** (only IDs, no names, etc.) Custom user-uploaded sound files for the soundboards: **User IDs**, **Server IDs** (only IDs, no names, creation dates, etc.), **Attachment file** (only the file, no filename, etc.). **Media attachments are stripped of all metadata.** To log what commands have been triggered and buttons have been clicked: **Interaction IDs**, **Server IDs**, **Channel IDs**, **Channel Type** (dm, text, thread, etc.), **User IDs** (only IDs, no names, etc.) ### **For how long do you store it?** Admin role IDs and the associated server IDs are kept for 14 days after Soundbort is removed from the server. Sound files are kept until a user deletes them, given they were added to the soundboard successfully. Otherwise they are instantly deleted. Sound files and earned slots from the server soundboard are kept for 14 days after Soundbort is removed from the server. Logs of commands, button presses and other interactions are kept for 30 days. ## How can I request deletion of my data? You can text `Loneless#0983` on Discord or `lonelessart@gmail.com` with your Discord tag (but I will need to still text you on Discord to ensure it's your account) and ask for a deletion of your data or your server's data. I will go through and check if you're a server admin and delete all associated data, that will include: * Your or your server's soundboard and all samples * Your or your server's additional sample slots you gained by upvoting the bot or other means * In case of server: any bot configurations like the admin role There will be an automated way in the future. # Terms of Service By adding Soundbort to your Discord server you agree to have read and understood the following terms of service. The terms of service are subject to change at any time without notice. You are strictly prohibited to use Soundbort against the these terms of service, the terms of service of Discord or for other purposes of illegal nature. ### Availability Soundbort is provided as-is. There are no guarantees that the service will be available in the future and its featureset may be changed at any time. ### Liability In an event of a system failure some or all user data may be lost. The team will try to restore as much data as it can from daily backups, but recovery may not be guaranteed. Soundbort reverses the right to delete user content in violation of these terms of service without warning and revoke access to all or specific features of Soundbort, for all or a specific user, at any time. Last updated: 25.10.2022 # Changelog The full changelog can be found on Github -> [Changelog](https://github.com/Soundbort/Soundbort/blob/main/CHANGELOG.md). # Contact It is preferred to reach the developers on Github by opening an issue if you have a question, a bug or a feature suggestion. Read the [Contributing](/guide/contributing) page in that case. I any other case feel free to hit a message. Here is the list of the developers: | Title | Name | Discord | Email | | ------------------------ | -------- | ------------- | ----------------------- | | Owner and main developer | Loneless | Loneless#0893 | |