Skip to content
This repository was archived by the owner on Apr 3, 2020. It is now read-only.

Commit 774223e

Browse files
committed
Update README
1 parent 1d5d616 commit 774223e

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,28 @@
22

33
This repository enables the use of [netcode.io](https://github.com/networkprotocol/netcode.io) via browser extensions, prior to it's adoption in browsers.
44

5-
**This is super experimental right now!**
6-
75
![gif of browser support](https://media.giphy.com/media/100PoL7yGm4Fi0/giphy.gif)
86

9-
## Installation
7+
## Supported Browsers
108

11-
For this to work, it requires the installation of both a browser extension and a native application helper which performs the actual netcode.io communication. The extension uses the native messaging APIs provided in browsers in order to make netcode.io available via the helper.
9+
netcode.io is supported in the following browsers via extensions:
1210

13-
To try this out in Google Chrome, you'll first need to build the `netcode.io.host.sln` solution in Visual Studio, then run `Install-Windows.ps1` in Powershell, which will install the netcode.io helper into the Windows registry.
11+
- Google Chrome
12+
- Firefox (pending extension approval)
1413

15-
After this is done, add the `browser\chrome` directory as an unpacked extension.
14+
Mobile device support is basically impossible until netcode.io support appears in browsers natively, as mobile platforms don't support extensions or native messaging.
1615

17-
The intention is that in the future, the extension will be available in the Chrome Web Store (and extension stores for Edge and Firefox). Upon installation of the extension, it would provide a native installation executable that sets up the helper for the user.
16+
## Installation
1817

19-
## Supported Browsers
18+
The easiest way to install netcode.io is to visit [the demo website](https://netcode.redpoint.games/), which will guide you through the setup of netcode.io.
2019

21-
So far this has been tested in Google Chrome, though it should translate to Edge and Firefox easily via the new WebExtensions specification.
20+
### From Source
2221

23-
Mobile device support is basically impossible until netcode.io support appears in browsers natively, as mobile platforms don't support extensions or native messaging.
22+
For this to work, it requires the installation of both a browser extension and a native application helper which performs the actual netcode.io communication. The extension uses the native messaging APIs provided in browsers in order to make netcode.io available via the helper.
23+
24+
To try this out in your browser, you'll first need to build the `netcode.io.host.sln` solution in Visual Studio, then run `Install-Windows.ps1` in Powershell, which will install the netcode.io helper into the Windows registry.
25+
26+
After this is done, add the `browser\webext` directory as an unpacked extension.
2427

2528
## netcode.io API
2629

0 commit comments

Comments
 (0)