mirror of
https://github.com/m1k1o/neko.git
synced 2024-07-24 14:40:50 +12:00
50 lines
2.5 KiB
Markdown
50 lines
2.5 KiB
Markdown
<div align="center">
|
|
<a href="https://n.eko.moe/#/" ><img src="https://raw.githubusercontent.com/nurdism/neko/master/docs/_media/logo.png" width="450" height="auto"/></a>
|
|
<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>
|
|
<br/>
|
|
<br/>
|
|
<img src="https://i.imgur.com/ZSzbQr7.gif" width="650" height="auto"/>
|
|
<br/>
|
|
<br/>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
## 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
|
|
|
|
## 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)
|