{"id":18885130,"url":"https://github.com/splitscreen-me/splitscreenme-discordbot","last_synced_at":"2025-04-14T21:30:51.667Z","repository":{"id":37022872,"uuid":"255045862","full_name":"SplitScreen-Me/splitscreenme-discordbot","owner":"SplitScreen-Me","description":"SplitScreen.Me - Discord Bot 🤖","archived":false,"fork":false,"pushed_at":"2024-02-10T18:53:48.000Z","size":123,"stargazers_count":3,"open_issues_count":14,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-02-10T19:40:57.889Z","etag":null,"topics":["bot","discord","discord-bot","discord-js","discordjs","gaming","javascript","nodejs","splitscreen"],"latest_commit_sha":null,"homepage":"https://www.splitscreen.me","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SplitScreen-Me.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":"Snailedlt"}},"created_at":"2020-04-12T09:09:12.000Z","updated_at":"2022-12-25T23:56:34.000Z","dependencies_parsed_at":"2024-02-10T19:47:21.483Z","dependency_job_id":null,"html_url":"https://github.com/SplitScreen-Me/splitscreenme-discordbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplitScreen-Me%2Fsplitscreenme-discordbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplitScreen-Me%2Fsplitscreenme-discordbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplitScreen-Me%2Fsplitscreenme-discordbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplitScreen-Me%2Fsplitscreenme-discordbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SplitScreen-Me","download_url":"https://codeload.github.com/SplitScreen-Me/splitscreenme-discordbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223644606,"owners_count":17178766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","discord","discord-bot","discord-js","discordjs","gaming","javascript","nodejs","splitscreen"],"created_at":"2024-11-08T07:16:58.029Z","updated_at":"2024-11-08T07:16:58.615Z","avatar_url":"https://github.com/SplitScreen-Me.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Snailedlt"],"categories":[],"sub_categories":[],"readme":"# SplitScreen.Me Discord Bot 🤖\r\n\u003cimg src=\"https://www.splitscreen.me/img/splitscreen-me-logo.png\" alt=\"SplitScreen.Me Logo\" width=\"100\" height=\"100\"\u003e\u003c/img\u003e\r\n\r\n![CI/CD](https://github.com/SplitScreen-Me/splitscreenme-discordbot/workflows/CI/badge.svg)\r\n![Swag](https://img.shields.io/badge/SayWhat-BeepBop-green)\r\n![Love](https://img.shields.io/badge/Love-MUCH-ff69b4)\r\n\r\n\u003e SplitScreen.Me is an open-source project attempting to make any game playable, in splitscreen mode.\r\n\r\n[Visit our website](https://www.splitscreen.me/) - [Join our Discord](https://discord.gg/S5jGb9T)\r\n\r\n## About the bot 🤖\r\n\r\nThe 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.\r\n\r\nBehind 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).\r\n\r\nFeel free to **contribute \u0026 help** us build the most amazing **bot for splitscreened games** ever !\r\n\r\n## How to use 💻\r\n\r\n\u003e The bot is public, anyone can invite it to its own Discord server.\r\n\r\n### Parameter types\r\n| Available parameter types | Explanation        |\r\n| ------------------------- | ------------------ |\r\n| \u003c \u003e                       | Optional parameter |\r\n| [ ]                       | Required parameter |\r\n\r\n### Commands\r\n| Command name  | Aliases                            | Usage                                         | Example Usage                                                            |\r\n| ------------- | ---------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------ |\r\n| help          | `cmds`, `commands`, `halp`         | ${prefix}help {command_name}                  | Shows a list of all available bot commands                               |\r\n| handler       | `h`, `script`                      | ${prefix}handler Borderlands                  | Return handler for the specified game.                                   |\r\n| create        | `c`, `make`                        | ${prefix}create [engineName] \u003c@user\u003e          | Creates the handler for a chosen GameEngine. For a list of supported Engines, use ${prefix}create options |\r\n| discord       | `d`, `disc`                        | ${prefix}discord                              | Return invite link to the Nucleus Coop Discord                           |\r\n| hubstats      |                                    | ${prefix}hubstats                             | Return stats from the hub                                                |\r\n\r\n### Examples\r\n| Commmand            | Screenshot                                                                                                                |\r\n| --------------------| ------------------------------------------------------------------------------------------------------------------------- |\r\n| -help               | ![-help](https://user-images.githubusercontent.com/43886029/134237392-205043e3-0619-4852-99c9-0cfbcba177b5.png)           |\r\n| -h left 4 dead      | ![-h left 4 dead](https://user-images.githubusercontent.com/43886029/134236654-dd8e888c-9b16-481e-ba41-3cc62e18f949.png)  |\r\n| -c diesel           | ![-c diesel](https://user-images.githubusercontent.com/43886029/134236614-02f5386e-831a-4d60-84bd-35680d7a675c.png)       |\r\n| -d                  | ![-d](https://user-images.githubusercontent.com/43886029/134236851-d11db3dc-8853-4f32-9c3a-e0d10d084e6c.png)              |\r\n| -hubstats           | ![-hubstats](https://user-images.githubusercontent.com/43886029/134237049-0c361f13-f69d-40c9-8f5e-f1cb9c0ebb8f.png)       |\r\n\r\n\r\n## Building 🚧\r\n\r\n### Create and invite  Discord bot/application\r\nTo 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.\r\nWatch the first 2 minutes of this video, to see how: https://youtu.be/JMmUW4d3Noc\r\n\r\n### Adding DISCORD_BOT_SECRET_TOKEN\r\nFrom 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.\r\n\r\n### Running locally\r\nto run the bot, run this in the terminal\r\n\r\n**Development:**\r\n```console\r\nyarn install\r\nyarn run start:dev\r\n```\r\n**Production:**\r\n\r\n```console\r\nyarn install\r\nyarn run start:prod\r\n```\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplitscreen-me%2Fsplitscreenme-discordbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplitscreen-me%2Fsplitscreenme-discordbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplitscreen-me%2Fsplitscreenme-discordbot/lists"}