Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.5 KB

README.md

File metadata and controls

55 lines (36 loc) · 1.5 KB
Raw

Portal

Portal is a peer-to-peer library and standalone executable designed to make peer-to-peer networking more accessible.

Downloads

Direct downloads

npm (Node Package Manager)

npm i -g @sogouda/portal

Usage

Replace portal in the following commands with the name of your portal executable.

Operating system Executable name
Linux portal
Windows portal.exe
Mac / OS X portal-osx

Host a server

Run the following command (replace 25565 with the port number of your server).

portal port host -p 25565

You'll see output similar to the following:

{"publicKey":"ed8d689b12d2a1998e7f284c16031bcb89cec5065c84e206975eebee438caf95"}

Copy the public key in between the parenthesis (in this case, ed8d689b12d2a1998e7f284c16031bcb89cec5065c84e206975eebee438caf95). Send this code to your friend. This is the code that your friend will need to paste in the following steps for joining a server.

Join a server

Run the following command (replace ed8d689b12d2a1998e7f284c16031bcb89cec5065c84e206975eebee438caf95 with the public key of your server).

portal port join -p 25565 ed8d689b12d2a1998e7f284c16031bcb89cec5065c84e206975eebee438caf95

This will output a JSON string containing the connection details.