master.shoukaku.shipgirl.moe Open in urlscan Pro
165.140.127.146 Public Scan

Back to summary

URL:
https://master.shoukaku.shipgirl.moe/
Submission: On March 27 via api (March 27th 2024, 11:59:37 pm UTC) from US — Scanned from US

Form analysis
1 forms found in the DOM

<form>
  <ul id="tsd-filter-options">
    <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected" data-has-instance="true"><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true">
          <rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect>
          <path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path>
        </svg><span>Protected</span></label></li>
    <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private" data-has-instance="true"><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true">
          <rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect>
          <path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path>
        </svg><span>Private</span></label></li>
    <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked="" data-has-instance="true"><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true">
          <rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect>
          <path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path>
        </svg><span>Inherited</span></label></li>
    <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" data-has-instance="true"><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true">
          <rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect>
          <path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path>
        </svg><span>External</span></label></li>
  </ul>
</form>

Text Content

 * Preparing search index...
 * The search index is not available

shoukaku



SHOUKAKU


SHOUKAKU

> A stable and updated wrapper around Lavalink





> The ShipGirl Project, feat Shoukaku; ⓒ Azur Lane


FEATURES

✅ Stable

✅ Documented

✅ Updated

✅ Extendable

✅ ESM & CommonJS supported

✅ Very cute (Very Important)


SUPPORTED LIBRARIES

Refer to /src/connectors for list of supported libraries + how to support other
libraries


INSTALLATION

> npm install shoukaku


DOCUMENTATION

https://shoukaku.shipgirl.moe/


SMALL CODE SNIPPET EXAMPLES

> Initializing the library (Using Connector Discord.JS)

const { Client } = require("discord.js");
const { Shoukaku, Connectors } = require("shoukaku");
const Nodes = [
  {
    name: "Localhost",
    url: "localhost:6969",
    auth: "re_aoharu",
  },
];
const client = new Client();
const shoukaku = new Shoukaku(new Connectors.DiscordJS(client), Nodes);
// ALWAYS handle error, logging it will do
shoukaku.on("error", (_, error) => console.error(error));
client.login("token");
// If you want shoukaku to be available on client, then bind it to it, here is one example of it
client.shoukaku = shoukaku;
Copy

> Never initialize Shoukaku like this, or else she will never initialize, start
> shoukaku before you call client.login()

// NEVER DO THIS, OR SHOUKAKU WILL NEVER INITIALIZE
client.on("ready", () => {
  client.shoukaku = new Shoukaku(new Connectors.DiscordJS(client), Nodes);
});
Copy

> Join a voice channel, search for a track, play the track, then disconnect
> after 30 seconds

const player = await shoukaku.joinVoiceChannel({
  guildId: "your_guild_id",
  channelId: "your_channel_id",
  shardId: 0, // if unsharded it will always be zero (depending on your library implementation)
});
// player is created, now search for a track
const result = await player.node.rest.resolve("scsearch:snowhalation");
if (!result?.tracks.length) return;
const metadata = result.tracks.shift();
// play the searched track
await player.playTrack({ track: metadata.encoded });
// disconnect after 30 seconds
setTimeout(() => shoukaku.leaveVoiceChannel(player.guildId), 30000).unref();
Copy

> Playing a track and changing a playback option (in this example, volume)

await player.playTrack({ track: metadata.encoded });
await player.setGlobalVolume(50);
Copy

> Updating the whole player if you don't want to use my helper functions

await player.update({ ...playerOptions });
Copy

> Setting a custom get node ideal function

const shoukaku = new Shoukaku(
  new Connectors.DiscordJS(client),
  [{ ...yourNodeOptions }],
  {
    ...yourShoukakuOptions,
    nodeResolver: (nodes, connection) => getYourIdealNode(nodes, connection),
  }
);
const player = await shoukaku.joinVoiceChannel({
  guildId: "your_guild_id",
  channelId: "your_channel_id",
  shardId: 0,
});
Copy


UPDATING FROM V3 -> V4 (NOTABLE CHANGES)

> The way of joining and leaving voice channels is now different

const { Client } = require("discord.js");
const { Shoukaku, Connectors } = require("shoukaku");
const Nodes = [
  {
    name: "Localhost",
    url: "localhost:6969",
    auth: "marin_kitagawa",
  },
];
const client = new Client();
const shoukaku = new Shoukaku(new Connectors.DiscordJS(client), Nodes);
shoukaku.on("error", (_, error) => console.error(error));
client.login("token");
client.once("ready", async () => {
  // get a node with least load to resolve a track
  const node = shoukaku.options.nodeResolver(shoukaku.nodes);
  const result = await node.rest.resolve("scsearch:snowhalation");
  if (!result?.tracks.length) return;
  // we now have a track metadata, we can use this to play tracks
  const metadata = result.tracks.shift();
  // you now join a voice channel by querying the main shoukaku class, not on the node anymore
  const player = await shoukaku.joinVoiceChannel({
    guildId: "your_guild_id",
    channelId: "your_channel_id",
    shardId: 0, // if unsharded it will always be zero (depending on your library implementation)
  });
  // if you want you can also use the player.node property after it connects to resolve tracks
  const result_2 = await player.node.rest.resolve("scsearch:snowhalation");
  console.log(result_2.tracks.shift());
  // now we can play the track
  await player.playTrack({ track: metadata.encoded });
  setTimeout(async () => {
    // simulate a timeout event, after specific amount of time, we leave the voice channel
    // you now destroy players / leave voice channels by calling leaveVoiceChannel in main shoukaku class
    await shoukaku.leaveVoiceChannel(player.guildId);
  }, 30000);
});
Copy

> Usual player methods now return promises

await player.playTrack(...data);
await player.stopTrack();
Copy

> There are 2 kinds of volumes you can set, global and filter

// global volume accepts 0-1000 as it's values
await player.setGlobalVolume(100);
// to check the current global volume
console.log(player.volume);
// filter volume accepts 0.0-5.0 as it's values
await player.setFilterVolume(1.0);
// to check the current filter volume (filters.volume can be undefined)
console.log(player.filters.volume);
Copy

> There are other internal changes like

// new variable in shoukaku class, which handles the "connection data" of discord only
console.log(shoukaku.connections);
// players are moved from `node.players` to `shoukaku.players`
console.log(shoukaku.players);
// getNode() is removed in favor of joinVoiceChannel, you can still get the default least loaded node via `shoukaku.options.nodeResolver()`
const player = await shoukaku.joinVoiceChannel({
  guildId: "your_guild_id",
  channelId: "your_channel_id",
  shardId: 0,
});
// you can supply a custom node resolver for your own way of getting an ideal node by supplying the nodeResolver option in Shoukaku options
const ShoukakuOptions = {
  ...yourShoukakuOptions,
  nodeResolver: (nodes, connection) => getYourIdealNode(nodes, connection),
};
// and other changes I'm not able to document(?);
Copy


SHOUKAKU'S OPTIONS

Option Type Default Description resume boolean false Whether to resume a
connection on disconnect to Lavalink (Server Side) (Note: DOES NOT RESUME WHEN
THE LAVALINK SERVER DIES) resumeTimeout number 30 Timeout before resuming a
connection in seconds resumeByLibrary boolean false Whether to resume the
players by doing it in the library side (Client Side) (Note: TRIES TO RESUME
REGARDLESS OF WHAT HAPPENED ON A LAVALINK SERVER) reconnectTries number 3 Number
of times to try and reconnect to Lavalink before giving up reconnectInterval
number 5 Timeout before trying to reconnect in seconds restTimeout number 60
Time to wait for a response from the Lavalink REST API before giving up in
seconds moveOnDisconnect boolean false Whether to move players to a different
Lavalink node when a node disconnects userAgent string (auto) User Agent to use
when making requests to Lavalink structures Object{rest?, player?} {} Custom
structures for shoukaku to use voiceConnectionTimeout number 15 Timeout before
abort connection in seconds nodeResolver function function Custom node resolver
if you want to have your own method of getting the ideal node


PLUGINS LIST

> Open a pr to add your plugin here

Name Link Description Kazagumo Github A Shoukaku wrapper that have built-in
queue system stone-deezer NPM A plugin to simplify deezer links and then play it
from available sources (REQUIRES KAZAGUMO)


OTHER LINKS

Support (#Development) | Lavalink


IMPLEMENTATION (DISCORD.JS)

> Kongou


MADE WITH ❤ BY

> 


SETTINGS

MEMBER VISIBILITY

 * Protected
 * Private
 * Inherited
 * External

THEME

OSLightDark


ON THIS PAGE

Shoukaku
 * Features
 * Supported Libraries
 * Installation
 * Documentation
 * Small code snippet examples
 * Updating from V3 -> V4 (notable changes)
 * Shoukaku's options
 * Plugins list
 * Other Links
 * Implementation (Discord.JS)
 * Made with ❤ by

shoukaku
 * Constants
    * OpCodes
    * State
    * Versions
    * VoiceState
    * NodeDefaults
    * ShoukakuDefaults

 * Shoukaku
    * Shoukaku
    * NodeOption
    * ShoukakuOptions
    * Structures
    * VoiceChannelOptions

 * Utils
    * Constructor
    * mergeDefault
    * wait

 * connectors
    * Connector
       * Connector
       * ConnectorMethods
       * AllowedPackets
   
    * libs
       * DiscordJS
       * Eris
       * OceanicJS
       * Seyfert
       * DiscordJS
          * DiscordJS
      
       * Eris
          * Eris
      
       * OceanicJS
          * OceanicJS
      
       * Seyfert
          * Seyfert

 * guild
    * Connection
       * Connection
       * ServerUpdate
       * StateUpdatePartial
   
    * Player
       * Player
       * Band
       * ChannelMixSettings
       * DistortionSettings
       * FilterOptions
       * FreqSettings
       * KaraokeSettings
       * LowPassSettings
       * PlayOptions
       * PlayerEvent
       * PlayerUpdate
       * ResumeOptions
       * RotationSettings
       * TimescaleSettings
       * TrackEndEvent
       * TrackExceptionEvent
       * TrackStartEvent
       * TrackStuckEvent
       * WebSocketClosedEvent
       * PlayerEventType
       * TrackEndReason

 * node
    * Node
       * Node
       * NodeStats
       * NonResumableHeaders
       * ResumableHeaders
       * NodeInfo
   
    * Rest
       * LoadType
       * Rest
       * Address
       * EmptyResult
       * ErrorResult
       * Exception
       * LavalinkPlayer
       * LavalinkPlayerVoice
       * LavalinkPlayerVoiceOptions
       * Playlist
       * PlaylistResult
       * RoutePlanner
       * SearchResult
       * SessionInfo
       * Track
       * TrackResult
       * UpdatePlayerInfo
       * UpdatePlayerOptions
       * LavalinkResponse
       * Severity

Generated using TypeDoc

master.shoukaku.shipgirl.moe Open in urlscan Pro 165.140.127.146 Public Scan

Form analysis 1 forms found in the DOM

Text Content

master.shoukaku.shipgirl.moe Open in urlscan Pro
165.140.127.146 Public Scan

Form analysis
1 forms found in the DOM