📝 docs: Add README.md (#42)

## Description **What issue are you solving (or what feature are you adding) and how are you doing it?** So, we need a README.md at the root of the project, to at least welcome anyone who might be interested in the project. It should have: - [ ] link to the `/play` endpoint to get a `session_id` for starting up the server. - [ ] (basic) info about how it works - [ ] features - [ ] images and/or gifs showcasing the project
nestrilabs · May 19, 2024 · a0956ec · a0956ec
1 parent b91b8bb
commit a0956ec
Show file tree

Hide file tree

Showing 7 changed files with 151 additions and 0 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -16,6  16,7 @@ labels:
     body: '(?i)breaking.*'
 
   - label: 'type/docs'
     branch: '^docs/.*'
     title: '^\s*.*?\sdocs(?:(. ))?!?:'
     branch: '^docs/.*'
     files:

diff --git a/README.md b/README.md
@@ -0,0  1,150 @@
 <div align="center">
 <div>
 
 <a href="https://netris.me" >
 <img height="160" src="/assets/logo.png">
 </a>
 
 </div>
 
 &nbsp;
 &nbsp;
 
 <div align="center" >
 <h1>
 <a href="https://netris.me" >
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="/assets/logo-name-white.png">
   <source media="(prefers-color-scheme: light)" srcset="/assets/logo-name-black.png">
   <img alt="netris logo name" src="/assets/logo-name-black.png">
 </picture>
 
 </a>
 
 </h1>
 
 </div>
 &nbsp;
 &nbsp;
 
 An open-source cloud gaming platform built for you to play together with your friends. <br/> A GeForce NOW alternative that can be self-hosted.<br/>
 
 </div>
 
 &nbsp;
 &nbsp;
  <div align="center" >
 
 [![][github-release-shield]][github-release-link]
 [![][discord-shield]][discord-link]
 [![][github-license-shield]][github-license-link]
 [![][github-stars-shield]][github-stars-link]
 
 **Share the Netris Repository on Social Media**
 
 [![][share-x-shield]][share-x-link]
 [![][share-reddit-shield]][share-reddit-link]
 
 </div>
 &nbsp;
 &nbsp;
 
 <div align="center" >
 
 [![][image-overview]][website-link]
 
 </div>
 
 ## Features 🌟
 
 As Netris navigates through its _experimental_ phase, we're in the process of crafting and testing a variety of features for you:
 
 1. **🎮 Proton-GE Compatibility:** We utilize Proton-GE for running games, offering extensive game compatibility and ensuring you can play a wide variety of titles.
 
 2. **⚡ QUIC Protocol:** For input and video/audio transmission, we use QUIC via [MoQ][moq-github-url] to significantly reduce latency on variable networks, ensuring crisp visuals without sacrificing data or increasing latency.
 
 3. **🔗 Session IDs:** With a `SESSION_ID`, we seamlessly tie your game progress, achievements, and devices without the need for logging into [netris.me][website-link]. Our public CDNs, currently located in Europe (eu-north-1) and the US (us-east-1), further reduce latency for friends playing together from afar. More locations are on the way!
 
 4. **🔄 Automatic Game Progress Sync:** Like Stadia's state share, we automatically sync your game progress based on the *.exe file you're running, allowing you to share your progress with friends via a link.
 
 5. **👫 Co-op Gameplay:** Play co-op with up to 8 people, or play single player by sharing mouse and keyboard inputs seamlessly (similar to [neko][neko-url]).
 
 6. **🌐 Cross-Platform Play:** Our platform is accessible on any device that can run a Chrome-based browser, including Edge, Chrome, Brave, and Arc. And you do not have to set up anything, it's all done and maintained for you.
 
 7. **📊 Bandwidth Optimization:** Experience hardware-accelerated `VMAF` for optimized bandwidth, ensuring the best possible video quality. [Learn More][vmaf-cuda-link]
 
 8. **🌟 ...and more:** Stay tuned as we continue to add features _sometimes inspired by platforms like Stadia_, to give you the best and most customizable gaming experience.
 
 This platform is in an _experimental_ phase, and we're actively working on adding new features. Your feedback and support is very much appreciated.
 
 > \[!IMPORTANT]
 >
 > If you're excited about what we're doing and want to support our journey, consider giving us a star ⭐ on our repository. Your support fuels our progress!. \~ ✨
 
 
 [![][image-star]][github-stars-link]
 
 
 ## Getting Started 🎮
 
 Whether you're looking to self-host Netris or simply want to try it out without the need for your own GPU, we've got you covered. Choose the path that best suits your needs:
 
 <!-- _You can always change your option later without losing game progress_ -->
 
 | If you don't have a Nvidia GPU or prefer not to self-host, you can visit our website. No installation or set up required ! <br/> This is the perfect option for gamers looking to dive straight into the action without any setup. | [👉🏽 Get Access][website-link] |
 | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |
 | If you're interested in self-hosting Netris, continue reading for detailed instructions on how to get started. <br/> This option is ideal if you have your own Nvidia GPU and are comfortable with setting up and managing your own server. | [🛠️ Self Host Netris](#self-hosting) |
 
 > \[!TIP]
 >
 > Remember, flexibility is key with Netris. You're free to switch between self-hosting and using `netris.me` whenever you like, without losing your game progress. \~ 💡
 <a name="self-hosting"></a>
 
 ### Self-Hosting Netris 🔨
 
 For those interested in self-hosting, here are is what you need to get your own Netris server up and running:
 
 - **Nvidia GPU**: Unfortunately, this setup is exclusive to Nvidia GPUs. If you don't own one, consider renting from cloud services like AWS, GCP, or Vast.ai. We highly recommend this approach.
 
 - **CUDA**: For GPU acceleration, CUDA version `12.0` or newer is required. Verify your CUDA installation by running `nvcc --version`.
 
 - **Docker**: Ensure you have `docker` and `nvidia-docker` are up to date to avoid compatibility issues with CUDA. You can check your Docker version by running `docker --version` in your terminal.
 
 - **GPU Driver**: Ensure your GPU drivers are up to date to avoid compatibility issues with CUDA. Nvidia driver version `520.56.06` or newer is required.
 
 - **Xorg Display**: Your Nvidia GPU should not be attached to a running X display server. You can confirm this by running `nvidia-smi`.
 
 - **Nvidia-DRM**: Make sure that the `nvidia-drm` module has been loaded and that the module is loaded with the flag `modeset=1`. Confirm this by running `sudo cat /sys/module/nvidia_drm/parameters/modeset` 
 
 > \[!TIP]
 >
 > Typically, if your setup meets the necessary CUDA requirements, the `nvidia-drm` module will already be loaded, particularly in AWS G4dn instances. \~ 💡
 
 ### Step-by-Step Guide
 
 Follow these steps to get Netris up and running on your system.
 
 > \[!IMPORTANT]
 >
 > Waiting on this pull request [#43][netris-pr-input] to be merged first. Sorry for the inconvenience. \~ ⚠️
 
 
 [github-release-link]: https://github.com/wanjohiryan/netris/releases
 [github-release-shield]: https://img.shields.io/github/v/release/wanjohiryan/netris?color=369eff&labelColor=black&logo=github&style=flat-square
 [discord-shield]: https://img.shields.io/discord/1080111004698021909?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
 [discord-link]: https://discord.com/invite/Y6etn3qKZ3
 [github-license-shield]: https://img.shields.io/github/license/wanjohiryan/netris?color=white&labelColor=black&style=flat-square
 [github-license-link]: https://github.com/wanjohiryan/netris/blob/main/LICENSE
 [github-stars-shield]: https://img.shields.io/github/stars/wanjohiryan/netris?color=ffcb47&labelColor=black&style=flat-square
 [github-stars-link]: https://github.com/wanjohiryan/netris/network/stargazers
 [share-x-shield]: https://img.shields.io/badge/-share on x-black?labelColor=black&logo=x&logoColor=white&style=flat-square
 [share-x-link]: https://twitter.com/intent/tweet?text=Hey, check out this Github repository. It is an open-source self-hosted Geforce Now alternative.&url=https://github.com/wanjohiryan/netris
 [share-reddit-shield]: https://img.shields.io/badge/-share on reddit-black?labelColor=black&logo=reddit&logoColor=white&style=flat-square
 [share-reddit-link]: https://www.reddit.com/submit?title=Hey, check out this Github repository. It is an open-source self-hosted Geforce Now alternative.&url=https://github.com/wanjohiryan/netris
 [image-overview]: assets/banner.png
 [website-link]: https://netris.me
 [neko-url]: https://github.com/m1k1o/neko
 [image-star]: assets/star-us.png
 [moq-github-url]: https://quic.video
 [vmaf-cuda-link]: https://developer.nvidia.com/blog/calculating-video-quality-using-nvidia-gpus-and-vmaf-cuda/
 [netris-pr-input]: https://github.com/netrisdotme/netris/pull/43
diff --git a/assets/banner.png b/assets/banner.png
diff --git a/assets/logo-name-black.png b/assets/logo-name-black.png
diff --git a/assets/logo-name-white.png b/assets/logo-name-white.png
diff --git a/assets/logo.png b/assets/logo.png
diff --git a/assets/star-us.png b/assets/star-us.png