Skip to content

Commit a0956ec

Browse files
authored
📝 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
1 parent b91b8bb commit a0956ec

File tree

7 files changed

+151
-0
lines changed

7 files changed

+151
-0
lines changed

.github/labeler.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ labels:
1616
body: '(?i)breaking.*'
1717

1818
- label: 'type/docs'
19+
branch: '^docs/.*'
1920
title: '^\s*.*?\sdocs(?:(.+))?!?:'
2021
branch: '^docs/.*'
2122
files:

README.md

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
<div align="center">
2+
<div>
3+
4+
<a href="https://netris.me" >
5+
<img height="160" src="/assets/logo.png">
6+
</a>
7+
8+
</div>
9+
10+
&nbsp;
11+
&nbsp;
12+
13+
<div align="center" >
14+
<h1>
15+
<a href="https://netris.me" >
16+
<picture>
17+
<source media="(prefers-color-scheme: dark)" srcset="/assets/logo-name-white.png">
18+
<source media="(prefers-color-scheme: light)" srcset="/assets/logo-name-black.png">
19+
<img alt="netris logo name" src="/assets/logo-name-black.png">
20+
</picture>
21+
22+
</a>
23+
24+
</h1>
25+
26+
</div>
27+
&nbsp;
28+
&nbsp;
29+
30+
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/>
31+
32+
</div>
33+
34+
&nbsp;
35+
&nbsp;
36+
<div align="center" >
37+
38+
[![][github-release-shield]][github-release-link]
39+
[![][discord-shield]][discord-link]
40+
[![][github-license-shield]][github-license-link]
41+
[![][github-stars-shield]][github-stars-link]
42+
43+
**Share the Netris Repository on Social Media**
44+
45+
[![][share-x-shield]][share-x-link]
46+
[![][share-reddit-shield]][share-reddit-link]
47+
48+
</div>
49+
&nbsp;
50+
&nbsp;
51+
52+
<div align="center" >
53+
54+
[![][image-overview]][website-link]
55+
56+
</div>
57+
58+
## Features 🌟
59+
60+
As Netris navigates through its _experimental_ phase, we're in the process of crafting and testing a variety of features for you:
61+
62+
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.
63+
64+
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.
65+
66+
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!
67+
68+
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.
69+
70+
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]).
71+
72+
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.
73+
74+
7. **📊 Bandwidth Optimization:** Experience hardware-accelerated `VMAF` for optimized bandwidth, ensuring the best possible video quality. [Learn More][vmaf-cuda-link]
75+
76+
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.
77+
78+
This platform is in an _experimental_ phase, and we're actively working on adding new features. Your feedback and support is very much appreciated.
79+
80+
> \[!IMPORTANT]
81+
>
82+
> 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!. \~
83+
84+
85+
[![][image-star]][github-stars-link]
86+
87+
88+
## Getting Started 🎮
89+
90+
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:
91+
92+
<!-- _You can always change your option later without losing game progress_ -->
93+
94+
| 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] |
95+
| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |
96+
| 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) |
97+
98+
> \[!TIP]
99+
>
100+
> 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. \~ 💡
101+
<a name="self-hosting"></a>
102+
103+
### Self-Hosting Netris 🔨
104+
105+
For those interested in self-hosting, here are is what you need to get your own Netris server up and running:
106+
107+
- **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.
108+
109+
- **CUDA**: For GPU acceleration, CUDA version `12.0` or newer is required. Verify your CUDA installation by running `nvcc --version`.
110+
111+
- **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.
112+
113+
- **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.
114+
115+
- **Xorg Display**: Your Nvidia GPU should not be attached to a running X display server. You can confirm this by running `nvidia-smi`.
116+
117+
- **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`
118+
119+
> \[!TIP]
120+
>
121+
> Typically, if your setup meets the necessary CUDA requirements, the `nvidia-drm` module will already be loaded, particularly in AWS G4dn instances. \~ 💡
122+
123+
### Step-by-Step Guide
124+
125+
Follow these steps to get Netris up and running on your system.
126+
127+
> \[!IMPORTANT]
128+
>
129+
> Waiting on this pull request [#43][netris-pr-input] to be merged first. Sorry for the inconvenience. \~ ⚠️
130+
131+
132+
[github-release-link]: https://github.com/wanjohiryan/netris/releases
133+
[github-release-shield]: https://img.shields.io/github/v/release/wanjohiryan/netris?color=369eff&labelColor=black&logo=github&style=flat-square
134+
[discord-shield]: https://img.shields.io/discord/1080111004698021909?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
135+
[discord-link]: https://discord.com/invite/Y6etn3qKZ3
136+
[github-license-shield]: https://img.shields.io/github/license/wanjohiryan/netris?color=white&labelColor=black&style=flat-square
137+
[github-license-link]: https://github.com/wanjohiryan/netris/blob/main/LICENSE
138+
[github-stars-shield]: https://img.shields.io/github/stars/wanjohiryan/netris?color=ffcb47&labelColor=black&style=flat-square
139+
[github-stars-link]: https://github.com/wanjohiryan/netris/network/stargazers
140+
[share-x-shield]: https://img.shields.io/badge/-share%20on%20x-black?labelColor=black&logo=x&logoColor=white&style=flat-square
141+
[share-x-link]: https://twitter.com/intent/tweet?text=Hey%2C%20check%20out%20this%20Github%20repository.%20It%20is%20an%20open-source%20self-hosted%20Geforce%20Now%20alternative.&url=https%3A%2F%2Fgithub.com%2Fwanjohiryan%2Fnetris
142+
[share-reddit-shield]: https://img.shields.io/badge/-share%20on%20reddit-black?labelColor=black&logo=reddit&logoColor=white&style=flat-square
143+
[share-reddit-link]: https://www.reddit.com/submit?title=Hey%2C%20check%20out%20this%20Github%20repository.%20It%20is%20an%20open-source%20self-hosted%20Geforce%20Now%20alternative.&url=https%3A%2F%2Fgithub.com%2Fwanjohiryan%2Fnetris
144+
[image-overview]: assets/banner.png
145+
[website-link]: https://netris.me
146+
[neko-url]: https://github.com/m1k1o/neko
147+
[image-star]: assets/star-us.png
148+
[moq-github-url]: https://quic.video
149+
[vmaf-cuda-link]: https://developer.nvidia.com/blog/calculating-video-quality-using-nvidia-gpus-and-vmaf-cuda/
150+
[netris-pr-input]: https://github.com/netrisdotme/netris/pull/43

assets/banner.png

2.17 MB
Loading

assets/logo-name-black.png

1.51 KB
Loading

assets/logo-name-white.png

1.45 KB
Loading

assets/logo.png

13.1 KB
Loading

assets/star-us.png

45.9 KB
Loading

0 commit comments

Comments
 (0)