Portalnet NPM | npm.io

♥ `mycel` ♥

♥~ Connect with your friends without paid server hosting or port forwarding ~♥

♥ P2P networking library | High-level API | Cross-platform ♥

What is Mycel?

Mycel is a peer-to-peer (P2P) networking library touting an easy-to-learn high-level API.

Desktop App

Coming soon!

CLI tool

Installation

Install globally

Please run the following command in your terminal/console:

npm i -g mycel

Install locally

To install locally to a project, please run the following command:

npm i -D mycel

Usage

Host

Run the following command, but make sure to replace {SERVER_PORT} with port of the server that you wish to host:

mycel port host -p {SERVER_PORT}

It will print an invite code (currently labeled publicKey) for you to copy and send to your friend. Your friend should then copy the code to paste into their join command. This will allow them to connect to the server that you're running on port {SERVER_PORT}.

Join

Run the following command, but make sure to replace {INVITE_CODE} with the invite code your friend sent, and replace {LOCAL_PORT} with the port on your computer that you would like the remote app to bind too:

mycel port join -p {LOCAL_PORT} {INVITE_CODE}

Now, if you wish to connect to a server on your friend's computer running on localhost:{SERVER_PORT}, you can join by connecting to localhost:{LOCAL_PORT}.

Daemon / background service