diff --git a/README.md b/README.md index 4b305375..21fa61ce 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,41 @@
- -

- release - license - pulls - issues - Chat on discord - build -

-
-
- -
-
- + +

+ release + license + pulls + issues + Chat on discord + build +

+
+
+ +
+
+# n.eko (m1k1o fork) +This app uses Web RTC to stream a desktop inside of a docker container. This is fork of https://github.com/nurdism/neko. +## Differences to original repository. -# n.eko - This app uses Web RTC to stream a desktop inside of a docker container, I made this because [rabb.it](https://en.wikipedia.org/wiki/Rabb.it) went under and my internet can't handle streaming and discord keeps crashing when my friend attempts to. I just want to watch anime with my friends ლ(ಠ益ಠლ) so I started digging throughout the internet and found a few *kinda* clones, but none of them had the virtual browser, then I found [Turtus](https://github.com/Khauri/Turtus) and I was able to figure out the rest. This is by no means a fully featured clone of rabbit, it hs only *one* room. It's stateless, so no saved user names or passwords. +### New Features +- Clipboard button with text area - for browsers, that don't support clipboard syncing or for HTTP. +- Keyboard modifier state synchronization (Num Lock, Caps Lock, Scroll Lock) for each hosting. +- Added chromium ungoogled (with h265 support) an kept up to date by @whalehub. +- Added Picture in Picture button (only for watching screen, controlling not possible). +- Added RTMP broadcast. Enables broadcasting neko screen to local RTMP server, YouTube or Twitch. +- Stereo sound (works properly only in Firefox host). -## Features - * Text Chat (With basic markdown support, discord flavor) - * Admin users (Kick, Ban & Force Give/Release Controls) - * Clipboard synchronization (on [supported browsers](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/readText)) - * Emote overlay - * Ignore user (chat and emotes) - * Persistent settings +### Bugs +- Fixed minor gst pipeline bug. +- Locked screen only for users, admins can still join. -## Why n.eko? -I like cats 🐱 (`Neko` is the Japanese word for cat), I'm a weeb/nerd - -***But why the cat butt?*** Because cats are *assholes*, but you love them anyways. - -## Documentation - -* [Getting Started](https://n.eko.moe/#/getting-started) - * [Quick Start](https://n.eko.moe/#/quick-start) - * [Configuration](https://n.eko.moe/#/configuration) -* [Development](https://n.eko.moe/#/development) - * [Client](https://n.eko.moe/#/client) - * [Server](https://n.eko.moe/#/server) - * [Docker](https://n.eko.moe/#/docker) - * [Non Goals](https://n.eko.moe/#/non-goals) - * [Contributing](https://n.eko.moe/#/contributing) - * [Change logs](https://n.eko.moe/#/change-logs/) -* [Technologies](https://n.eko.moe/#/technologies) -* [Glossary](https://n.eko.moe/#/glossary) +### Misc +- Custom docker workflow. +- Based on debian buster instead of stretch. +- Custom avatars without any 3rd party depenency. +- Ignore duplicate notify bars. +- No pointer events for notify bars. +- Disable debug mode by default.