Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 6 days 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 (over 4 years ago)
Default Branch: master
Last Pushed: 2024-02-10T18:53:48.000Z (9 months ago)
Last Synced: 2024-02-10T19:40:57.889Z (9 months 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 🤖



![CI/CD](https://github.com/SplitScreen-Me/splitscreenme-discordbot/workflows/CI/badge.svg)

![Swag](https://img.shields.io/badge/SayWhat-BeepBop-green)

![Love](https://img.shields.io/badge/Love-MUCH-ff69b4)

> 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               | ![-help](https://user-images.githubusercontent.com/43886029/134237392-205043e3-0619-4852-99c9-0cfbcba177b5.png)           |

| -h left 4 dead      | ![-h left 4 dead](https://user-images.githubusercontent.com/43886029/134236654-dd8e888c-9b16-481e-ba41-3cc62e18f949.png)  |

| -c diesel           | ![-c diesel](https://user-images.githubusercontent.com/43886029/134236614-02f5386e-831a-4d60-84bd-35680d7a675c.png)       |

| -d                  | ![-d](https://user-images.githubusercontent.com/43886029/134236851-d11db3dc-8853-4f32-9c3a-e0d10d084e6c.png)              |

| -hubstats           | ![-hubstats](https://user-images.githubusercontent.com/43886029/134237049-0c361f13-f69d-40c9-8f5e-f1cb9c0ebb8f.png)       |

## 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

```