![\"NPM\"](\"https://nodei.co/npm/discord-together.png\")
\r\n \r\n
\r\n \r\n ![\"Made](\"https://forthebadge.com/images/badges/made-with-javascript.svg\")
\r\n \r\n ![\"Downloads\"](\"https://img.shields.io/npm/dt/discord-together?style=for-the-badge\")
\r\n\r\n\r\n---\r\n\r\n# Discord Together\r\n\r\nA simple, type-safe, and lightweight Node.js library to generate Discord Together invite links for over 23+ activities and games, supporting all versions of [discord.js](https://www.npmjs.com/package/discord.js).\r\n\r\n---\r\n\r\n## ðĐ Installation\r\n\r\n### Install [discord-together](https://www.npmjs.com/package/discord-together)\r\n```sh\r\nnpm install discord-together@latest\r\n```\r\n\r\n### Install [discord.js](https://www.npmjs.com/package/discord.js)\r\n```sh\r\nnpm install discord.js@latest\r\n```\r\n*Supports all versions of Discord.js*\r\n\r\n---\r\n\r\n## ð Features\r\n\r\n- ð Easy to use\r\n- ð Multiple server support\r\n- ð ïļ Works with all Discord.js versions\r\n- ðŪ 23+ games and activities\r\n- ðŠķ Lightweight and type-safe\r\n- ðĪ Actively maintained\r\n- ðĶ Extendable configuration\r\n\r\n---\r\n\r\n## ð Table of Contents\r\n\r\n- [Basic Example](#-basic-example)\r\n- [API Reference](#-api-reference)\r\n- [Advanced Usage](#-advanced-usage)\r\n - [Custom Application Config](#custom-application-config)\r\n - [Factory Usage](#factory-usage)\r\n- [Available Games](#-all-available-games)\r\n- [Example Bots](#-example-of-bots-made-with-discord-together)\r\n- [License & Credits](#-others)\r\n- [Support](#support)\r\n\r\n---\r\n\r\n## ðŧ Basic Example\r\n\r\nA simple example using this package with Discord.js v14+:\r\n\r\n```js\r\nimport { Client, GatewayIntentBits } from 'discord.js';\r\nimport { DiscordTogether } from 'discord-together';\r\n\r\nconst client = new Discord.Client({ intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages, GatewayIntentBits.MessageContent] });\r\nconst togetherInstance = new DiscordTogether(client);\r\n\r\nclient.on('messageCreate', async message => { \r\n if (message.content === 'start') {\r\n if(message.member.voice.channel) {\r\n togetherInstance.createTogetherCode(message.member.voice.channel.id, 'chess').then(async res => {\r\n return message.channel.send(`${res.invite}`);\r\n })\r\n };\r\n };\r\n});\r\n\r\nclient.login('TOKEN');\r\n```\r\n\r\n---\r\n\r\n## ð API Reference\r\n\r\n### `DiscordTogether` class\r\n\r\n#### Constructor\r\n\r\n```ts\r\nnew DiscordTogether(client: Client, applications?: ApplicationConfig)\r\n```\r\n- `client`: Your Discord.js client instance (must be logged in).\r\n- `applications` (optional): Custom application config. Defaults to built-in games.\r\n\r\n#### Methods\r\n\r\n##### `createTogetherCode(channelId: Snowflake, application: string): Promise<{ code: string, invite: string }>`\r\n- `channelId`: The ID of the voice channel.\r\n- `application`: The key of the game/activity (see [Available Games](#-all-available-games)).\r\n- **Returns:** An object with the invite code and the full invite URL.\r\n\r\n---\r\n\r\n### `createDiscordTogether` factory\r\n\r\n```ts\r\nimport { createDiscordTogether } from \"discord-together\";\r\n\r\nconst createTogetherCode = createDiscordTogether(client, applications);\r\n```\r\n- Returns the `createTogetherCode` function directly for functional usage.\r\n\r\n---\r\n\r\n## âïļ Advanced Usage\r\n\r\n### Custom Application Config\r\n\r\nYou can extend or override the default games with your own:\r\n\r\n```ts\r\nimport { createApplicationConfig, DefaultApplicationsConfig, DiscordTogether } from \"discord-together\";\r\n\r\n// Extend the default config with your own games\r\nconst extendedConfig = createApplicationConfig(\r\n { monopoly: \"your_snowflake_id\" },\r\n { extends: [DefaultApplicationsConfig] }\r\n);\r\n\r\nconst instance = new DiscordTogether(client, extendedConfig);\r\n```\r\n\r\n### Factory Usage\r\n\r\n```ts\r\nimport { createDiscordTogether } from \"discord-together\";\r\n\r\n// Returns the createTogetherCode function\r\nconst createTogetherCode = createDiscordTogether(client, applications);\r\n```\r\n\r\n---\r\n\r\n## ðŪ All Available Games\r\n\r\n| Key | Description |\r\n|----------------|---------------------------|\r\n| youtube | YouTube Together |\r\n| youtubedev | YouTube Dev |\r\n| poker | Poker Night |\r\n| betrayal | Betrayal.io |\r\n| fishing | Fishington.io |\r\n| chess | Chess in the Park |\r\n| chessdev | Chess Dev |\r\n| lettertile | Letter Tile |\r\n| wordsnack | Word Snack |\r\n| doodlecrew | Doodle Crew |\r\n| awkword | Awkword |\r\n| spellcast | SpellCast |\r\n| checkers | Checkers in the Park |\r\n| puttparty | Putt Party |\r\n| sketchheads | Sketch Heads |\r\n| ocho | Ocho |\r\n| puttpartyqa | Putt Party QA |\r\n| sketchyartist | Sketchy Artist |\r\n| land | Land |\r\n| meme | Meme |\r\n| askaway | Ask Away |\r\n| bobble | Bobble |\r\n| bashout | Bash Out |\r\n\r\n---\r\n\r\n\r\n## ð Example of Bots Made with Discord Together\r\n\r\n- [Discord Together Bot](https://github.com/RemyK888/discord-together-bot) by [RemyK](https://github.com/RemyK888)\r\n- [Lambdapse](https://github.com/lambdagit101/lambdapse) by [Lambdaguy101](https://github.com/lambdagit101)\r\n\r\n---\r\n\r\n## ð License & Credits\r\n\r\n- **License:** MIT\r\n- **Author:** [RemyK](https://github.com/RemyK888)\r\n- **Special thanks:** [Ayomits](https://github.com/Ayomits) for the TypeScript rewrite, and all contributors and community members!\r\n\r\n*This package is not affiliated with Discord Inc. or YouTube Inc.*\r\n\r\n---\r\n\r\n## ðŽ Support\r\n\r\nIf you have any problems or questions, feel free to contact [RemyK](https://discord.com/users/509397999924019211).\r\n\r\n- **Discord server:** [Server Link](https://discord.gg/GK8jFXkybz)\r\n- **GitHub repository:** [discord-together](https://github.com/RemyK888/discord-together)\r\n\r\n---\r\n\r\nMade with âĪ by RemyK
\r\n","readmeFilename":"README.md"}