SplitScreen.Me Discord Bot 🤖

SplitScreen.Me is an open-source project attempting to make any game playable, in splitscreen mode.

About the bot 🤖

The Bot is created using basic EcmaScript (JavaScript) code, interpreted by NodeJS, along with the powerful Discord.js module.

Behind the scene, it requests to the public SplitScreen.Me Hub API using 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 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 you just made, copy the token for your bot into the value field of DISCORD_BOT_SECRET_TOKEN in 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:

yarn install
yarn run start:dev

Production:

yarn install
yarn run start:prod

errorline99 / splitscreenme-discordbot Goto Github PK