This version is outdated by a newer approved version.DiffThis version (2020/02/06 17:58) is a draft.
Approvals: 0/1

This is an old revision of the document!


Netplay is a feature enabled by RetroArch and some libretro cores to play games with multiple players over the network. If you want to play Double Dragon on NES with your buddy who sits several miles away from you… using netplay you can play both as Player 1 and Player 2 over the Internet, like if you were both playing on the same console, sitting next to each other.

How does this black magic work?

Netplay relies on a client/server architecture. One of the players starts by setting up a Netplay game room, with a Netplay server, where the other players connect to, as clients.

Also, all isn't “magic” here. There are several limitations to be aware of:

  1. You need a very stable Internet connection, with a low ping value. Like any other multi-player game over the internet, your user experience is heavily depending on the quality of your internet connection. Prefer wired ethernet networking over wifi if possible.
  2. All players in a Netplay session need to have the same core version, and the same ROM to play together. That means that you need to use the same Batocera release version, and you should always check and compare the MD5 checksums of the ROM that all members in your party are going to use. It might work when using a slightly different core version, or ROM, but your mileage may vary. If possible, get all the players use the same versions.
  3. Check that you use a core that is compatible with Netplay - see below for the list of cores that support Netplay. Not all cores are compatible, sometimes for the same console, only a few core are compatible with Netplay.
  4. Check that all the members of your party are using the same architecture. Some cores don't enable cross-architecture Netplay. Picodrive for Megadrive/Genesis will not let you play across a PC and Raspberry Pi, for technical endianness reasons. Whenever this happens, you'll see a message popping-up upon launching the RetroArch core.

First of all, make sure you have Batocera 5.25 or later. Netplay is not available for earlier Batocera releases. If you personalized your es_systems.cfg, you need to use the one shipped by Batocera or update yours again based on the current /usr/share/emulationstation/es_systems.cfg as it has embeds new commands to enable netplay.

You need to enable netplay by adding global.netplay=1 in /userdata/system/batocera.conf.

Once this is done, you can check that Netplay is enabled as when you see the help line at the bottom of the screen that tells you that button X in EmulationStation is now used for Netplay options (and not “Random selection” any more)

One of the players needs to host a Netplay server, to which the others players will connect to. When you are on the “systems” list of EmulationStation (the menu where you can select all the consoles, not the games), pressing the “X” button will give you a list of all available Netplay servers and games in progress.

Some games are greyed out: there are some technical reasons why you can't join these games (different core version, game you don't own, or a different version of the game, and so on).

Select a game that you can join, and launch it: pay close attention to the messages that are popping up when RetroArch launches. Sometimes, there are limitations that could not be detected before and that will prevent you from playing (for example some cores don't support cross-platform Netplay, meaning that you can't have some players with a PC and others with a Raspberry Pi on the same game).

If you want to host your own Netplay game and let your buddies join it, you can do so by entering the “games” selection menu, and pressing X to launch a NetPlay server. Tell your buddies to join your Netplay room, when your game is launched it should appear in the menu described above.

When you host a Netplay server, you have to make sure that your network is either compatible with UPNP to automatically open the right port, or you can define your own port in the settings, and configure your router and network to keep this port open from the outside.

If you can't do it, or don't know how to do it, you can use the MITM option in the settings, that acts like a relay and simplify the Netplay server configuration.

Configuration with Games SettingsNetplay Settings

  1. Enable Netplay: on/off.
  2. Nickname: how you will be presented in the Netplay game rooms (useful for the other players to find you and make sure they join the right room).
  3. Port: if you need to define a specific port to enable Netplay. This is depending on your network configuration, and you can leave the default as empty if your router is UPNP compatible.
  4. MITM: in case your network can't let you open UPNP ports to host Netplay games, you can use this as a relay for hosting your Netplay game. It does introduce more latency though, so use this option only if your network can't open UPNP ports automatically
  5. Reindex all games: let Batocera index all your ROMs in order to present only the game rooms with ROMs compatible with yours.
  6. Index missing games: same, but only when you have just added new ROMs to your Batocera.

This is the list for Batocera 5.25, it may change based on the evolution of the cores over time.

Arcade

  • FBNeo
  • Imame
  • Mame
  • Mame2003 Plus
  • Mame2010

Arcade Lightgun

  • Mame2003 Plus
  • Mame 2010

Arcade Atomiswave & Naomi

  • Flycast

Nintendo SNES

  • Pocketsnes
  • Snes9x_next
  • Snes9x
  • Mesen-s
  • Bsnes

Nintendo NES

  • Fceumm
  • Nestopia
  • Mesen

Nintendo GameBoy 2 Players

  • Tgbdual

Nintendo NDS

  • Desmume

Nintendo Famicom Disk system

  • Fceumm
  • Nestopia

Nintendo Virtualboy

  • Beetle VB

Sega Dreamcast

  • Flycast

Sega Megadrive/Genesis

  • GenesisPlusGX
  • Picodrive (does not support cross-architecture netplay)

Sega 32X

  • Picodrive

Sega Master System

  • GenesisPlusGX
  • Picodrive

Sega Gamegear

  • GenesisPlusGX

NEC PC Engine and PC Engine CD

  • Beetle PCE

NEC SuperGrafx

  • Beetle SuperGrafx

Neogeo and Neogeo CD

  • FBNeo

Neogeo Pocket and Pocket Color

  • Beetle NGP

Atari 2600

  • Stella

Atari Lynx

  • Beetle Lynx
  • Handy

Wonderswan and Wonderswan Color

  • Beetle Wswan

Amstrad CPC

  • Cap32

Amstrad GX4000

  • Cap32

Sinclair ZX81

  • 81

Sega Saturn

  • Beetle Saturn

3DO

  • 4DO

SatellaView and Sufami

  • Snes9x

Thomson

  • Theodore

PC98

  • PC98
  • netplay.1581008299.txt.gz
  • Last modified: 4 years ago
  • by lbrpdx