iridium/neko
2
2
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2024-07-24 14:40:50 +12:00
Code Issues Packages Projects Releases Wiki Activity

created readme with changes for this fork

Browse Source
This commit is contained in:
m1k1o 2021-01-14 22:05:14 +01:00
parent f093ef762b
commit f0e2766daf
1 changed files with 34 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
README.md
View File

@ -1,50 +1,41 @@
<div align="center"> <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> <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"> <p align="center">
<img src="https://img.shields.io/github/v/release/nurdism/neko" alt="release"> <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/github/license/nurdism/neko" alt="license">
<img src="https://img.shields.io/docker/pulls/nurdism/neko" alt="pulls"> <img src="https://img.shields.io/docker/pulls/nurdism/neko" alt="pulls">
<img src="https://img.shields.io/github/issues/nurdism/neko" alt="issues"> <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/> <a href="https://discord.gg/3U6hWpC" ><img src="https://discordapp.com/api/guilds/665851821906067466/widget.png" alt="Chat on discord"><a/>
<a href="https://github.com/nurdism/neko/actions" ><img src="https://github.com/nurdism/neko/workflows/deploy/badge.svg" alt="build"><a/> <a href="https://github.com/nurdism/neko/actions" ><img src="https://github.com/nurdism/neko/workflows/deploy/badge.svg" alt="build"><a/>
</p> </p>
<br/> <br/>
<br/> <br/>
<img src="https://i.imgur.com/ZSzbQr7.gif" width="650" height="auto"/> <img src="https://i.imgur.com/ZSzbQr7.gif" width="650" height="auto"/>
<br/> <br/>
<br/> <br/>
</div> </div>
# 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 ### New Features
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. - 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 ### Bugs
* Text Chat (With basic markdown support, discord flavor) - Fixed minor gst pipeline bug.
* Admin users (Kick, Ban & Force Give/Release Controls) - Locked screen only for users, admins can still join.
* 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? ### Misc
I like cats 🐱 (`Neko` is the Japanese word for cat), I'm a weeb/nerd - Custom docker workflow.
- Based on debian buster instead of stretch.
***But why the cat butt?*** Because cats are *assholes*, but you love them anyways. - Custom avatars without any 3rd party depenency.
- Ignore duplicate notify bars.
## Documentation - No pointer events for notify bars.
- Disable debug mode by default.
* [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)