Skip to content

Commit

Permalink
Merge pull request #51 from RainyXeon/dev
Browse files Browse the repository at this point in the history
Release Rainlink v1.0.0
  • Loading branch information
RainyXeon authored May 12, 2024
2 parents 941ba4e + 864e194 commit 0f9630a
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 234 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

Another lavalink wrapper but focus on stability and rich features

# ⚠️ Warning!!

⚠️ This lavalink wrapper is just in the beta stage, it will have some bug so please report it on github!

⚠️ Update 5: Rainlink now in stage 25 of development (Near stable)

# 🌟 Features
- Stable client
- Support TypeScript
Expand Down Expand Up @@ -49,6 +43,7 @@ This is the list of all rainlink plugin currently supported
| rainlink-deezer | Official | [npmjs](https://www.npmjs.com/package/rainlink-deezer) / [github](https://github.com/RainyProduction/rainlink-deezer) | RainyXeon |
| rainlink-apple | Official | [npmjs](https://www.npmjs.com/package/rainlink-apple) / [github](https://github.com/RainyProduction/rainlink-apple) | RainyXeon |
| rainlink-spotify | Official | [npmjs](https://www.npmjs.com/package/rainlink-spotify) / [github](https://github.com/RainyProduction/rainlink-spotify) | RainyXeon |
| rainlink-voice | Official | [npmjs](hhttps://www.npmjs.com/package/rainlink-voice) / [github](https://github.com/RainyProduction/rainlink-voice) | RainyXeon |

# ⚙ Drivers

Expand All @@ -62,6 +57,21 @@ This is the list of all rainlink driver currently supported (codename is made up
| frequenc/v1/miku | [FrequenC](https://github.com/PerformanC/FrequenC) | C | IN TESTING | miku | This driver is in testing so don't use it or you will have errors |

# 📃 Migrtation logs:
## 0.9.2 -> 1.0.0
```diff
src/index.ts
- Plugin
- Plugin.VoiceReceiver
- Plugin.PlayerMoved
src/Interface/Constants.ts
- VoiceConnect = 'voiceConnect',
- VoiceDisconnect = 'voiceDisconnect',
- VoiceError = 'voiceError',
- VoiceStartSpeaking = 'voiceStartSpeaking',
- VoiceEndSpeaking = 'voiceEndSpeaking',
src/Plugin/RainlinkPlugin.ts
+ isRainlinkPlugin
```

## 0.9.0 -> 0.9.2
```diff
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "rainlink",
"version": "0.9.4",
"version": "1.0.0",
"description": "Another lavalink wrapper but focus on stability and rich features",
"repository": {
"type": "git",
Expand Down
6 changes: 0 additions & 6 deletions src/Interface/Constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,6 @@ export enum RainlinkEvents {
QueueShuffle = 'queueShuffle',
QueueClear = 'queueClear',
QueueEmpty = 'queueEmpty',
// Voice receiver
VoiceConnect = 'voiceConnect',
VoiceDisconnect = 'voiceDisconnect',
VoiceError = 'voiceError',
VoiceStartSpeaking = 'voiceStartSpeaking',
VoiceEndSpeaking = 'voiceEndSpeaking',
}

/**
Expand Down
121 changes: 0 additions & 121 deletions src/Plugin/VoiceReceiver/Plugin.ts

This file was deleted.

26 changes: 0 additions & 26 deletions src/Plugin/index.ts

This file was deleted.

72 changes: 0 additions & 72 deletions src/Rainlink.ts
Original file line number Diff line number Diff line change
Expand Up @@ -158,40 +158,6 @@ export declare interface Rainlink {
*/
on(event: 'queueEmpty', listener: (player: RainlinkPlayer, queue: RainlinkQueue) => void): this;
////// ------------------------- Queue Event ------------------------- /////

////// ------------------------- Voice Event ------------------------- /////
/**
* Emitted when connected to voice receive server [ONLY Nodelink DRIVER!!!!!!].
* @event Rainlink#voiceConnect
*/
on(event: 'voiceConnect', listener: (node: RainlinkNode) => void): this;
/**
* Emitted when disconnected to voice receive server [ONLY Nodelink DRIVER!!!!!!].
* @event Rainlink#voiceDisconnect
*/
on(event: 'voiceDisconnect', listener: (node: RainlinkNode, code: number, reason: Buffer) => void): this;
/**
* Emitted when voice receive server errored [ONLY Nodelink DRIVER!!!!!!].
* @event Rainlink#VoiceError
*/
on(event: 'VoiceError', listener: (node: RainlinkNode, error: Error) => void): this;
/**
* Emitted when user started speaking [ONLY Nodelink DRIVER!!!!!!].
* @event Rainlink#voiceStartSpeaking
*/
on(
event: 'voiceStartSpeaking',
listener: (node: RainlinkNode, userId: string, guildId: string) => void,
): this;
/**
* Emitted when user finished speaking [ONLY Nodelink DRIVER!!!!!!].
* @event Rainlink#voiceEndSpeaking
*/
on(
event: 'voiceEndSpeaking',
listener: (node: RainlinkNode, userTrack: string, userId: string, guildId: string) => void,
): this;
////// ------------------------- Voice Event ------------------------- /////
// ------------------------- ON EVENT ------------------------- //

// ------------------------- ONCE EVENT ------------------------- //
Expand Down Expand Up @@ -260,25 +226,6 @@ export declare interface Rainlink {
/** @ignore */
once(event: 'queueEmpty', listener: (player: RainlinkPlayer, queue: RainlinkQueue) => void): this;
////// ------------------------- Queue Event ------------------------- /////

////// ------------------------- Voice Event ------------------------- /////
/** @ignore */
once(event: 'voiceConnect', listener: (node: RainlinkNode) => void): this;
/** @ignore */
once(event: 'voiceDisconnect', listener: (node: RainlinkNode, code: number, reason: Buffer) => void): this;
/** @ignore */
once(event: 'VoiceError', listener: (node: RainlinkNode, error: Error) => void): this;
/** @ignore */
once(
event: 'voiceStartSpeaking',
listener: (node: RainlinkNode, userId: string, guildId: string) => void,
): this;
/** @ignore */
once(
event: 'voiceEndSpeaking',
listener: (node: RainlinkNode, userTrack: string, userId: string, guildId: string) => void,
): this;
////// ------------------------- Voice Event ------------------------- /////
// ------------------------- ONCE EVENT ------------------------- //

// ------------------------- OFF EVENT ------------------------- //
Expand Down Expand Up @@ -347,25 +294,6 @@ export declare interface Rainlink {
/** @ignore */
off(event: 'queueEmpty', listener: (player: RainlinkPlayer, queue: RainlinkQueue) => void): this;
////// ------------------------- Queue Event ------------------------- /////

////// ------------------------- Voice Event ------------------------- /////
/** @ignore */
off(event: 'voiceConnect', listener: (node: RainlinkNode) => void): this;
/** @ignore */
off(event: 'voiceDisconnect', listener: (node: RainlinkNode, code: number, reason: Buffer) => void): this;
/** @ignore */
off(event: 'VoiceError', listener: (node: RainlinkNode, error: Error) => void): this;
/** @ignore */
off(
event: 'voiceStartSpeaking',
listener: (node: RainlinkNode, userId: string, guildId: string) => void,
): this;
/** @ignore */
off(
event: 'voiceEndSpeaking',
listener: (node: RainlinkNode, userTrack: string, userId: string, guildId: string) => void,
): this;
////// ------------------------- Voice Event ------------------------- /////
// ------------------------- OFF EVENT ------------------------- //
}

Expand Down
2 changes: 0 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { metadata } from './metadata';
import Library from './Library';
import Plugin from './Plugin';

// Export main class
export * from './Rainlink';
Expand Down Expand Up @@ -30,7 +29,6 @@ export * from './Interface/Track';
// Export plugin
export * from './Plugin/RainlinkPlugin';
export * from './Plugin/SourceRainlinkPlugin';
export { Plugin };
// Export driver
export * from './Drivers/AbstractDriver';
export * from './Drivers/Lavalink3';
Expand Down

0 comments on commit 0f9630a

Please sign in to comment.