neko/docs/README.md

25 lines
1.3 KiB
Markdown
Raw Normal View History

2020-02-03 11:49:19 +13:00
<div align="center">
2020-02-10 13:59:08 +13:00
<img src="_media/logo.png" width="450" height="auto"/>
<br/>
<br/>
2020-02-03 11:49:19 +13:00
<img src="https://i.imgur.com/ZSzbQr7.gif" width="650" height="auto"/>
2020-02-10 13:59:08 +13:00
<br/>
<br/>
2020-02-03 11:49:19 +13:00
</div>
2020-02-10 13:59:08 +13:00
# n.eko
2020-02-03 11:49:19 +13:00
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.
### Features
* Text Chat (With basic markdown support, discord flavor)
* Admin users (Kick, Ban & Force Give/Release Controls)
2020-02-10 13:59:08 +13:00
* Clipboard synchronization (on [supported browsers](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/readText))
2020-02-03 11:49:19 +13:00
* Emote overlay
* Ignore user (chat and emotes)
2020-02-10 13:59:08 +13:00
* Persistent settings
2020-02-03 11:49:19 +13:00
2020-02-10 13:59:08 +13:00
### Why n.eko?
2020-02-03 11:49:19 +13:00
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.