https://github.com/lemaitre4523/discord-soundboard-launcher
A player capable of playing soundboards uploaded to a discord server.
https://github.com/lemaitre4523/discord-soundboard-launcher
discord discord-soundboard launcher player soundboard
Last synced: 4 months ago
JSON representation
A player capable of playing soundboards uploaded to a discord server.
- Host: GitHub
- URL: https://github.com/lemaitre4523/discord-soundboard-launcher
- Owner: LeMaitre4523
- License: mit
- Created: 2023-08-14T19:22:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-14T19:53:24.000Z (almost 2 years ago)
- Last Synced: 2025-01-16T02:49:06.893Z (5 months ago)
- Topics: discord, discord-soundboard, launcher, player, soundboard
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord SoundBoard Launcher
A player capable of playing soundboards uploaded to a discord server.
[](https://choosealicense.com/licenses/mit/)
## Roadmap
- [x] Fetch default soundboards
- [ ] Fetch guild soundboards
- [x] Play default soundboards
- [ ] Play guild soundboards
## Usage/Examples
### Caution: The client must be connected to the voice channel and not muted
```javascript
const SoundBoardLauncher = require("./bot-soundboard-launcher")
const soundboard = new SoundBoardLauncher(client)
soundboard.fetchSoundBoards(null, true)
setTimeout(function() {
soundboard.playSoundBoard("992791685266419844", "747412099361407077", "3")
}, 10000)
```
## API Reference
#### Get all soundboards for guild
```javascript
fetchSoundBoards(guildId, default)
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `guildId` | `string` | **Required**. ID of the guild |
| `default` | `boolean` | Fetch discord default soundboard |
#### Play soundboard to a voice channel
```javascript
playSoundBoard(channelId, guildId, soundboardId)
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `channelId` | `string` | **Required**. ID of the voice channel |
| `guildId` | `string` | **Required**. ID of the guild |
| `soundboardId` | `string` | **Required**. ID of the soundboard |
## Authors
- [@LeMaitre4523](https://www.github.com/lemaitre4523)