{"id":13467608,"url":"https://github.com/shipgirlproject/Shoukaku","last_synced_at":"2025-03-26T03:30:46.614Z","repository":{"id":38848591,"uuid":"191595111","full_name":"shipgirlproject/Shoukaku","owner":"shipgirlproject","description":"A stable, powerful and updated wrapper around Lavalink","archived":false,"fork":false,"pushed_at":"2024-10-28T15:00:41.000Z","size":5608,"stargazers_count":287,"open_issues_count":9,"forks_count":86,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-10-28T17:34:35.721Z","etag":null,"topics":["discord-js","discord-music-bot","discordjs","eris","eris-lavalink","lavalink","lavalink-client","lavalink-music","lavalink-wrapper"],"latest_commit_sha":null,"homepage":"https://guide.shoukaku.shipgirl.moe/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shipgirlproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":"TheWeebSaya","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-06-12T15:12:39.000Z","updated_at":"2024-10-28T15:00:45.000Z","dependencies_parsed_at":"2023-02-12T09:20:21.865Z","dependency_job_id":"18d93a5e-ba80-40d8-bd7f-20070480c15f","html_url":"https://github.com/shipgirlproject/Shoukaku","commit_stats":{"total_commits":748,"total_committers":46,"mean_commits":16.26086956521739,"dds":0.3743315508021391,"last_synced_commit":"19555bbd0334dbe7397f44edf682d3d1b7589fe9"},"previous_names":["deivu/shoukaku"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipgirlproject%2FShoukaku","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipgirlproject%2FShoukaku/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipgirlproject%2FShoukaku/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipgirlproject%2FShoukaku/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shipgirlproject","download_url":"https://codeload.github.com/shipgirlproject/Shoukaku/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222074733,"owners_count":16926589,"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":["discord-js","discord-music-bot","discordjs","eris","eris-lavalink","lavalink","lavalink-client","lavalink-music","lavalink-wrapper"],"created_at":"2024-07-31T15:00:58.436Z","updated_at":"2024-10-29T20:30:40.816Z","avatar_url":"https://github.com/shipgirlproject.png","language":"TypeScript","funding_links":["https://patreon.com/TheWeebSaya"],"categories":["TypeScript"],"sub_categories":[],"readme":"## Shoukaku\n\n\u003e A stable and updated wrapper around Lavalink\n\n[![Discord](https://img.shields.io/discord/423116740810244097?style=flat-square)](https://discordapp.com/invite/FVqbtGu)\n[![npm](https://img.shields.io/npm/v/shoukaku?style=flat-square)](https://www.npmjs.com/package/shoukaku)\n![Github Stars](https://img.shields.io/github/stars/Deivu/Shoukaku?style=flat-square)\n![GitHub issues](https://img.shields.io/github/issues-raw/Deivu/Shoukaku?style=flat-square)\n![NPM](https://img.shields.io/npm/l/shoukaku?style=flat-square)\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://safe.saya.moe/OlYoY5xxkMLO.png\"\u003e \n\u003c/p\u003e\n\n\u003e Shoukaku, from Azur Lane, drawn by: elfenlied22\n\n### Features\n\n- Stable\n\n- Updated\n\n- Documented\n\n- Extendable\n\n- ESM \u0026 CommonJS supported\n\n- Very cute (Very Important)\n\n### Documentation\n\n\u003e https://guide.shoukaku.shipgirl.moe/\n\n### Getting Started\n\n\u003e https://guide.shoukaku.shipgirl.moe/guides/1-getting-started/\n\n### Supported Libraries\n\n\u003e https://guide.shoukaku.shipgirl.moe/guides/5-connectors/\n\n### Example Bot\n\n\u003e https://github.com/Deivu/Kongou\n\n### Configuration Options\n\n```js\n// Parameters for main class init, Options is the Configuration Options\nnew Shoukaku(new Connectors.DiscordJS(client), Nodes, Options);\n```\n\n| Option                 | Type                   | Default  | Description                                                                                      | Notes                    |\n| ---------------------- | ---------------------- | -------- | ------------------------------------------------------------------------------------------------ | ------------------------ |\n| resume                 | boolean                | false    | If you want to enable resuming when your connection when your connection to lavalink disconnects |                          |\n| resumeTimeout          | number                 | 30       | Timeout before lavalink destroys the players on a disconnect                                     | In seconds               |\n| resumeByLibrary        | boolean                | false    | If you want to force resume players no matter what even if it's not resumable by lavalink        |                          |\n| reconnectTries         | number                 | 3        | Number of tries to reconnect to lavalink before disconnecting                                    |                          |\n| reconnectInterval      | number                 | 5        | Timeout between reconnects                                                                       | In seconds               |\n| restTimeout            | number                 | 60       | Maximum amount of time to wait for rest lavalink api requests                                    | In seconds               |\n| moveOnDisconnect       | boolean                | false    | Whether to move players to a different lavalink node when a node disconnects                     |                          |\n| userAgent              | string                 | (auto)   | Changes the user-agent used for lavalink requests                                                | Not recommeded to change |\n| structures             | Object{rest?, player?} | {}       | Custom structures for shoukaku to use                                                            |                          |\n| voiceConnectionTimeout | number                 | 15       | Maximum amount of time to wait for a join voice channel command                                  | In seconds               |\n| nodeResolver           | function               | function | Custom node resolver if you want to have your own method of getting the ideal node               |                          |\n\n### Wrappers\n\n| Name     | Link                                          | Description                                              |\n| -------- | --------------------------------------------- | -------------------------------------------------------- |\n| Kazagumo | [Github](https://github.com/Takiyo0/Kazagumo) | A wrapper for Shoukaku that has an internal queue system |\n\n\u003e Open a pr if you want to add a wrapper here\n\n### Other Links\n\n- [Discord](https://discord.gg/FVqbtGu)\n\n- [Lavalink](https://github.com/lavalink-devs/Lavalink)\n\n### Code made with ❤ by @ichimakase (Saya)\n\n\u003e The Shipgirl Project","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipgirlproject%2FShoukaku","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshipgirlproject%2FShoukaku","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipgirlproject%2FShoukaku/lists"}