From b0ee3be5ed7a520bab8989534dacd61679337b3c Mon Sep 17 00:00:00 2001 From: copygirl Date: Mon, 9 Dec 2024 07:56:33 +0100 Subject: [PATCH] Update README --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4a38770..8cfcb5b 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,23 @@ # copyMultiplayer -A relatively straight-forward module for [SnekStudio] allowing for multiple users to -connect together, share their tracking data in real-time, and display their models in -a single application. +A relatively straight-forward module for [SnekStudio] allowing for multiple users +to connect together, share tracking data in real-time, and display their models, +all in a single application! ![Screenshot](Docs/screenshot.png) ## Features -- Supports for more than just two players. +- Supports more than just two simultaneous players. - Detects when you switch models, and syncs accordingly. +- Made by yet another monster girl! 💚 ## Limitations -- Very proof-of-concept, needs more work done to be usable. -- Requires pre-sharing model files, to be placed in "cache" directory. +- Requires pre-sharing model files, placed in "cache" directory. - Missing peer-to-peer functionality, requires host to forward port. - Locations and scale of other players' models currently hardcoded. -- Currently dumps all bone and blendshapes info into an update packet per frame, which - ends up being >8KB, waaaay too large. This is the biggest flaw but considering the - project was thrown together in a day, I hope you'll forgive me for now. 💚 +- Currently uses about 12–36 KB/s of bandwidth. Working on improving that. +- Only syncronizes a hardcoded set of bones for now. [SnekStudio]: https://github.com/ExpiredPopsicle/SnekStudio