Skip to main content

Configure your Mirror Server

Configure your mirror server port and enable features with the configuration file

config.json
{
   "port": 8080,
   "netplay": {
       "enabled": false,
       "TWILIO_ACCOUNT_SID": "",
       "TWILIO_AUTH_TOKEN": ""
   }
}

Change default port​

To change the default port modify the port value in your config to a port of your choice (port must not already be used). See a list of offical ports here.

Use netplay​

caution

Netplay is still in beta, some features may not work.

The netplay plugin is used for multiplayer emulator games to be played over the internet via the mirror server. You cannot access other netplay instances via different mirror servers.

Configure Twillo​

Twillo is needed to run the netplay server. Twillo has a free plan that we will be using for the configuration.

Step By Step:

  1. Open their website and sign up or login if you already have an account
  2. Once you have logged into twillo scroll down to account info and copy your Account SID and Auth Token (Don't commit these tokens as they can be used to access your account)
  3. Past them into the matching fields and set netplay enabled to true

The mirror server uses a slightly modified version of emulator.js's netplay server.