pianoverse_client/readme.md

37 lines
No EOL
1.6 KiB
Markdown

# [Pianoverse Client for pianoverse.me](https://pianoverse.me/)
Extracted from the https://pianoverse.net site at 10:33, November 25.
Commit ID: 6202927ae53e43bafd8b8fd3be1ffcaaa45426a3
## Patches
This client contains two patches, internal.patch, and ws.patch.
1. ws.patch
| localStorage.host value | connnects to |
|:-----------------------:|:-----------------:|
| | api.pianoverse.me |
| mainline | pianoverse.net |
| dev | 127.0.0.1:8081 |
| anything else | localStorage.host |
2. internal.patch
Exposes all internal pianoverse APIs on window.PvInternals.
Use nushell and `build/createPatchedBundle.nu` in the root to create a bundle.js.
## extra.js
extra.js contains the following features
1. PopupManager.open rewrite
Rewrites a internal function called PopupManager.open, the only way to add Popups without this rewrite was to hook into PopupManager.open and jerry-rig a implenmentation. However, with this rewrite you can add popups to a map at PvInternal.popupMap.
2. Rules button & modal
This is a simple button in the top of the screen, which shows rules.
3. Emoji picker
There is a emoji picker. I hand picked some emojis from discord, ask if you want more. There are also normal emojis, for those you have to search in the search bar.
This emoji picker also requires "emojis.json", which is in the repository already.
4. Rebrand
I also added a thing that changes the title of the website from Pianoverse to pv.me, same with the top of the screen. Helps me differenciate which site I'm on.
## Sounds
Use the `build/downloadSounds.nu` nushell script to download all sounds.