2020-01-14 00:28:14 +13:00
< div align = "center" >
2020-02-10 14:58:24 +13:00
< a href = "https://n.eko.moe/#/" > < img src = "https://raw.githubusercontent.com/nurdism/neko/master/docs/_media/logo.png" width = "450" height = "auto" / > < / a >
2020-04-06 13:41:07 +12:00
< p align = "center" >
< img src = "https://img.shields.io/github/v/release/nurdism/neko" alt = "release" >
< img src = "https://img.shields.io/github/license/nurdism/neko" alt = "license" >
< img src = "https://img.shields.io/docker/pulls/nurdism/neko" alt = "pulls" >
< img src = "https://img.shields.io/github/issues/nurdism/neko" alt = "issues" >
< a href = "https://discord.gg/3U6hWpC" > < img src = "https://discordapp.com/api/guilds/665851821906067466/widget.png" alt = "Chat on discord" > < a / >
< / p >
2020-02-10 13:59:08 +13:00
< br / >
< br / >
2020-01-24 06:29:20 +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-04-06 13:41:07 +12:00
2020-01-14 22:39:47 +13:00
< / div >
2020-04-06 13:41:07 +12:00
2020-02-10 13:59:08 +13:00
# n.eko
2020-01-29 14:28:27 +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.
2020-01-13 21:05:38 +13:00
2020-02-10 14:58:24 +13:00
## Features
2020-01-31 12:57:38 +13:00
* Text Chat (With basic markdown support, discord flavor)
2020-01-29 23:25:54 +13:00
* Admin users (Kick, Ban & Force Give/Release Controls)
2020-02-03 11:48:39 +13:00
* Clipboard synchronization (on [supported browsers ](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/readText ))
2020-01-29 23:25:54 +13:00
* Emote overlay
* Ignore user (chat and emotes)
2020-02-10 13:59:08 +13:00
* Persistent settings
2020-01-29 23:25:54 +13:00
2020-02-10 14:58:24 +13:00
## Why n.eko?
2020-01-29 14:28:27 +13:00
I like cats 🐱 (`Neko` is the Japanese word for cat), I'm a weeb/nerd
2020-01-29 02:41:55 +13:00
2020-01-29 14:28:27 +13:00
***But why the cat butt?*** Because cats are *assholes* , but you love them anyways.
2020-02-10 14:58:24 +13:00
## 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 )
