https://github.com/splitscreen-me/splitscreenme-discordbot
SplitScreen.Me - Discord Bot 🤖
https://github.com/splitscreen-me/splitscreenme-discordbot
bot discord discord-bot discord-js discordjs gaming javascript nodejs splitscreen
Last synced: about 1 year ago
JSON representation
SplitScreen.Me - Discord Bot 🤖
- Host: GitHub
- URL: https://github.com/splitscreen-me/splitscreenme-discordbot
- Owner: SplitScreen-Me
- Created: 2020-04-12T09:09:12.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-10T18:53:48.000Z (over 2 years ago)
- Last Synced: 2024-02-10T19:40:57.889Z (over 2 years ago)
- Topics: bot, discord, discord-bot, discord-js, discordjs, gaming, javascript, nodejs, splitscreen
- Language: JavaScript
- Homepage: https://www.splitscreen.me
- Size: 120 KB
- Stars: 3
- Watchers: 3
- Forks: 4
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# SplitScreen.Me Discord Bot 🤖
> SplitScreen.Me is an open-source project attempting to make any game playable, in splitscreen mode.
[Visit our website](https://www.splitscreen.me/) - [Join our Discord](https://discord.gg/S5jGb9T)
## About the bot 🤖
The Bot is created using basic EcmaScript (JavaScript) code, interpreted by [NodeJS](https://nodejs.org/), along with the powerful [Discord.js](https://discord.js.org/) module.
Behind the scene, it requests to the [public SplitScreen.Me Hub API](https://github.com/SplitScreen-Me/splitscreenme-hub) using [Axios](https://github.com/axios/axios).
Feel free to **contribute & help** us build the most amazing **bot for splitscreened games** ever !
## How to use 💻
> The bot is public, anyone can invite it to its own Discord server.
### Parameter types
| Available parameter types | Explanation |
| ------------------------- | ------------------ |
| < > | Optional parameter |
| [ ] | Required parameter |
### Commands
| Command name | Aliases | Usage | Example Usage |
| ------------- | ---------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------ |
| help | `cmds`, `commands`, `halp` | ${prefix}help {command_name} | Shows a list of all available bot commands |
| handler | `h`, `script` | ${prefix}handler Borderlands | Return handler for the specified game. |
| create | `c`, `make` | ${prefix}create [engineName] <@user> | Creates the handler for a chosen GameEngine. For a list of supported Engines, use ${prefix}create options |
| discord | `d`, `disc` | ${prefix}discord | Return invite link to the Nucleus Coop Discord |
| hubstats | | ${prefix}hubstats | Return stats from the hub |
### Examples
| Commmand | Screenshot |
| --------------------| ------------------------------------------------------------------------------------------------------------------------- |
| -help |  |
| -h left 4 dead |  |
| -c diesel |  |
| -d |  |
| -hubstats |  |
## Building 🚧
### Create and invite Discord bot/application
To run the bot locally, you need to create a [Discord bot](https://discord.com/developers/applications) through the Discord developer portal, and invite it to your server.
Watch the first 2 minutes of this video, to see how: https://youtu.be/JMmUW4d3Noc
### Adding DISCORD_BOT_SECRET_TOKEN
From the [Discord bot](https://discord.com/developers/applications) you just made, copy the token for your bot into the value field of `DISCORD_BOT_SECRET_TOKEN` in [settings-development.json](settings-development.json). To select which channels you want the bot to access, copy the channel id's into the `DEVELOPMENT_CHANNELS` array, in the same file.
### Running locally
to run the bot, run this in the terminal
**Development:**
```console
yarn install
yarn run start:dev
```
**Production:**
```console
yarn install
yarn run start:prod
```