sophie/pianoverse
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

update readme to be way better, and bump PV & package.json

Browse source
This commit is contained in:
Soph :3 2024-07-23 11:58:21 +03:00
parent 039582baae
commit 53ca898b13
Signed by: sophie
GPG key ID: EDA5D222A0C270F2
3 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,14 +1,15 @@
# pianoverse client for TS # pianoverse.net protodef's and client
This contains the protocol definitions for pianoverse.net. Reversed from using protobuf_inspector on the packets sent through server and client.
## install ## Requirements
run `bun add pianoverse` 1. [Bun](https://bun.sh/docs/installation)
then import `pianoverse`
## requirements ## Contact
1. bun Please contact me on Discord @fucksophie. I'm in the pianoverse discord. You can also find me [elsewhere](https://sad.ovh).
2. a brain
## Example
The general API is styled after MPP clients, which Pianoverse has quite a lot of similarities with.
## example
```ts ```ts
import { Client } from "pianoverse" import { Client } from "pianoverse"
@ -24,4 +25,4 @@ client.on("message", (user, content) => {
client.message("Hi :P") client.message("Hi :P")
} }
}) })
``` ```

2
package.json
View file

@ -2,7 +2,7 @@
"name": "pianoverse", "name": "pianoverse",
"module": "index.ts", "module": "index.ts",
"type": "module", "type": "module",
"version": "v1.0.0", "version": "v1.0.1",
"license": "GPL-3.0-only", "license": "GPL-3.0-only",
"homepage": "https://git.sad.ovh/sophie/pianoverse", "homepage": "https://git.sad.ovh/sophie/pianoverse",
"bugs": "https://git.sad.ovh/sophie/pianoverse/issues", "bugs": "https://git.sad.ovh/sophie/pianoverse/issues",

2
pianoverse.proto
View file

@ -1,4 +1,4 @@
// PV version = 13661e19e8c210d990baa4d96aa8905430c709d5 // PV version = 0cdf4ec01ef9a5de77ad785183b3f56fcd0b58db
syntax = "proto3"; syntax = "proto3";