mpp-client-net 1.2.2 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -4
- package/build/index.d.ts +12 -0
- package/build/index.d.ts.map +1 -1
- package/build/index.js +51 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
This module is a fork of the [MPP.net client](https://github.com/mppnet/frontend). This module is only meant for [MPP.net](https://multiplayerpiano.net), but it will likely work on any MPP site that uses token-based authentication in the same way as MPP.net.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
This is not meant to work in the browser. It is for independent runtimes like Bun, Deno, or Node.js.
|
|
6
6
|
|
|
7
7
|
## Usage
|
|
8
8
|
|
|
9
9
|
It is strongly recommended that you keep your bot tokens in a safe place where nobody else can access them.
|
|
10
10
|
Personally, I keep mine in a `.env` file in the root of my project, as that is a typical place for project secrets.
|
|
11
11
|
|
|
12
|
-
For more information on
|
|
12
|
+
For more information on how to interact with the server, see the [MPP.net Protocol Documentation](https://github.com/mppnet/frontend/blob/main/docs/protocol.md).
|
|
13
13
|
|
|
14
14
|
```env
|
|
15
15
|
# .env
|
|
@@ -19,15 +19,16 @@ MPPNET_TOKEN=your token here
|
|
|
19
19
|
```ts
|
|
20
20
|
// index.ts
|
|
21
21
|
|
|
22
|
-
// Load environment variables into process.env
|
|
22
|
+
// Load environment variables into process.env (not required for bun)
|
|
23
23
|
import { configDotenv } from "dotenv";
|
|
24
24
|
configDotenv();
|
|
25
25
|
|
|
26
26
|
import { Client } from "mpp-client-net";
|
|
27
27
|
|
|
28
|
-
//
|
|
28
|
+
// Instantiate a new client
|
|
29
29
|
const client = new Client("wss://mppclone.com", process.env.MPPNET_TOKEN);
|
|
30
30
|
|
|
31
|
+
// Connect to the server
|
|
31
32
|
client.start();
|
|
32
33
|
client.setChannel('test/awkward');
|
|
33
34
|
|
package/build/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { EventEmitter } from "events";
|
|
2
2
|
import { WebSocket } from "ws";
|
|
3
|
+
import { ChannelInfo, Participant, User, LoginInfo, AccountInfo, Note, ChannelSettings, EmittableEvents, IncomingEvents, OutgoingEvents, LocalEvents, LoginType, NoteLetter, NoteOctave, Tag } from "./types";
|
|
3
4
|
export declare class Client extends EventEmitter {
|
|
4
5
|
uri: string;
|
|
5
6
|
token?: string | undefined;
|
|
@@ -65,6 +66,17 @@ export declare class Client extends EventEmitter {
|
|
|
65
66
|
setLoginInfo(loginInfo: LoginInfo): void;
|
|
66
67
|
on<Event extends keyof EmittableEvents>(event: Event, listener: (msg: EmittableEvents[Event]) => void): this;
|
|
67
68
|
emit<Event extends keyof EmittableEvents>(event: Event, ...args: Parameters<(msg: EmittableEvents[Event]) => void>): boolean;
|
|
69
|
+
sendChat(message: string): void;
|
|
70
|
+
chown(id?: Participant["id"]): void;
|
|
71
|
+
setName(name: string): void;
|
|
72
|
+
setColor(color: string): void;
|
|
73
|
+
userset(set: Partial<{
|
|
74
|
+
name: string;
|
|
75
|
+
color: string;
|
|
76
|
+
}>): void;
|
|
77
|
+
setCursor(x: number | string, y: number | string): void;
|
|
78
|
+
chset(set: Partial<ChannelSettings>): void;
|
|
68
79
|
}
|
|
69
80
|
export default Client;
|
|
81
|
+
export { ChannelInfo, Participant, User, LoginInfo, AccountInfo, Note, ChannelSettings, EmittableEvents, IncomingEvents, OutgoingEvents, LocalEvents, LoginType, NoteLetter, NoteOctave, Tag };
|
|
70
82
|
//# sourceMappingURL=index.d.ts.map
|
package/build/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC/B,OAAO,EACH,WAAW,EACX,WAAW,EACX,IAAI,EACJ,SAAS,EACT,WAAW,EACX,IAAI,EACJ,eAAe,EACf,eAAe,EACf,cAAc,EACd,cAAc,EACd,WAAW,EACX,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,EACN,MAAM,SAAS,CAAC;AAEjB,qBAAa,MAAO,SAAQ,YAAY;IAqBjB,GAAG,EAAE,MAAM;IAAS,KAAK,CAAC,EAAE,MAAM;IApB9C,EAAE,EAAE,SAAS,GAAG,SAAS,CAAC;IAC1B,gBAAgB,SAAK;IACrB,IAAI,EAAE,IAAI,GAAG,SAAS,CAAC;IACvB,aAAa,EAAE,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAC7C,OAAO,EAAE,WAAW,GAAG,SAAS,CAAC;IACjC,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,CAAM;IACjD,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,kBAAkB,SAAK;IACvB,gBAAgB,EAAE,WAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACjD,sBAAsB,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAC7D,YAAY,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IACzC,UAAU,UAAS;IACnB,UAAU,EAAE,IAAI,EAAE,CAAM;IACxB,cAAc,SAAK;IACnB,iBAAiB,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC9C,WAAW,EAAE,GAAG,CAAM;IACtB,IAAI,EAAE,MAAM,CAAK;IACjB,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC,WAAW,EAAE,WAAW,GAAG,SAAS,CAAC;gBAEzB,GAAG,EAAE,MAAM,EAAS,KAAK,CAAC,EAAE,MAAM,YAAA;IAO9C,WAAW;IAIX,WAAW;IAQX,YAAY;IAQZ,KAAK;IAOL,IAAI;IAKJ,OAAO;IAkGd,SAAS,CAAC,kBAAkB;IA+C5B,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM;IAInB,SAAS,CAAC,KAAK,SAAS,MAAM,cAAc,EAC/C,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE;IAKzB,UAAU,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC;IAc7D,SAAS,CAAC,sBAAsB,EAAE,OAAO,CAAC,eAAe,CAAC,CAExD;IAEK,iBAAiB,CAAC,GAAG,EAAE,MAAM;IAQ7B,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC;IAmB5D,SAAS,CAAC,kBAAkB;;;;MAI1B;IAEK,iBAAiB;;;;;IAIxB,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,WAAW,EAAE;IAyBrC,iBAAiB;IAUjB,iBAAiB,CAAC,MAAM,EAAE,GAAG;IAmB7B,oBAAoB,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC;IAShD,iBAAiB,CAAC,EAAE,EAAE,WAAW,CAAC,IAAI,CAAC;IAUvC,mBAAmB,CAAC,EAAE,CAAC,EAAE,MAAM;;;;;IAM/B,OAAO;IAQP,eAAe;IASf,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IA8B7C,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC;IAsBzC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;IAiBxB,QAAQ;IASR,YAAY,CAAC,SAAS,EAAE,SAAS;IAIjC,EAAE,CAAC,KAAK,SAAS,MAAM,eAAe,EACzC,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,CAAC,KAAK,CAAC,KAAK,IAAI,GAChD,IAAI;IAKA,IAAI,CAAC,KAAK,SAAS,MAAM,eAAe,EAC3C,KAAK,EAAE,KAAK,EACZ,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,GAAG,EAAE,eAAe,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,GAC3D,OAAO;IASH,QAAQ,CAAC,OAAO,EAAE,MAAM;IAOxB,KAAK,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC;IAO5B,OAAO,CAAC,IAAI,EAAE,MAAM;IASpB,QAAQ,CAAC,KAAK,EAAE,MAAM;IAStB,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAOrD,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAWhD,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,eAAe,CAAC;CAM7C;AAED,eAAe,MAAM,CAAC;AAEtB,OAAO,EACH,WAAW,EACX,WAAW,EACX,IAAI,EACJ,SAAS,EACT,WAAW,EACX,IAAI,EACJ,eAAe,EACf,eAAe,EACf,cAAc,EACd,cAAc,EACd,WAAW,EACX,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,EACN,CAAC"}
|
package/build/index.js
CHANGED
|
@@ -385,6 +385,57 @@ class Client extends events_1.EventEmitter {
|
|
|
385
385
|
return false;
|
|
386
386
|
}
|
|
387
387
|
}
|
|
388
|
+
sendChat(message) {
|
|
389
|
+
this.sendArray([{
|
|
390
|
+
m: "a",
|
|
391
|
+
message
|
|
392
|
+
}]);
|
|
393
|
+
}
|
|
394
|
+
chown(id) {
|
|
395
|
+
this.sendArray([{
|
|
396
|
+
m: "chown",
|
|
397
|
+
id: id
|
|
398
|
+
}]);
|
|
399
|
+
}
|
|
400
|
+
setName(name) {
|
|
401
|
+
this.sendArray([{
|
|
402
|
+
m: "userset",
|
|
403
|
+
set: {
|
|
404
|
+
name
|
|
405
|
+
}
|
|
406
|
+
}]);
|
|
407
|
+
}
|
|
408
|
+
setColor(color) {
|
|
409
|
+
this.sendArray([{
|
|
410
|
+
m: "userset",
|
|
411
|
+
set: {
|
|
412
|
+
color
|
|
413
|
+
}
|
|
414
|
+
}]);
|
|
415
|
+
}
|
|
416
|
+
userset(set) {
|
|
417
|
+
this.sendArray([{
|
|
418
|
+
m: "userset",
|
|
419
|
+
set
|
|
420
|
+
}]);
|
|
421
|
+
}
|
|
422
|
+
setCursor(x, y) {
|
|
423
|
+
if (typeof x === "number")
|
|
424
|
+
x = x.toFixed(2);
|
|
425
|
+
if (typeof y === "number")
|
|
426
|
+
y = y.toFixed(2);
|
|
427
|
+
this.sendArray([{
|
|
428
|
+
m: "m",
|
|
429
|
+
x,
|
|
430
|
+
y
|
|
431
|
+
}]);
|
|
432
|
+
}
|
|
433
|
+
chset(set) {
|
|
434
|
+
this.sendArray([{
|
|
435
|
+
m: "chset",
|
|
436
|
+
set
|
|
437
|
+
}]);
|
|
438
|
+
}
|
|
388
439
|
}
|
|
389
440
|
exports.Client = Client;
|
|
390
441
|
exports.default = Client;
|
package/package.json
CHANGED