You will need the following items before you begin:
- Raspberry Pi 1/2/3/4 (any model, but note that Model A, A+ have no Ethernet Adapter. For RPi Zero, see here instead)
- SD Card (Minimum 8GB)
- Cat 5/5e/6 Ethernet Cable
- HDMI Monitor with HDMI Cable (optional, see below)
- LCD Module Display (optional, see below)
We have a preference for the Raspberry Pi 3 Model B+ as it is quite powerful but still uses the standard HDMI connection. If you do not have a Raspberry Pi handy, then there is no point in proceeding any further. Come back when you have one!
Write the extracted image (.img) file to an SD card. Etcher is a great, simple tool for this job.
Insert the SD card into a Raspberry Pi and boot while connected to a LAN port on your broadband router and (optionally) a HDMI monitor.
The Raspberry Pi will show the server network address on the monitor when booted up.
If you are a *nix smartass you could also do something like the following at the command line:
If you are willing to make a small hardware purchase, you can even display the IP Address to an LCD Module, which we think is pretty f*cking neat!
No matter what method you use, connect to the discovered IP Address using the console (¬ or ~ key) in your favorite game client with connect <server ip address> eg. connect 10.2.2.185.
QuakeWorld has been compiled to support both port 26000 and port 27500 so you should be able to connect with any engine you want, even much older ones. We have fully tested and can recommend both FTEWQ and Mark V as clients that work well with Quake On LAN.
You can leave the Raspberry Pi powered on indefinitely if you wish, but check with whoever pays the bill. As a guide, the Pi3B uses only 230 mA when idle (Pi3B+ uses 400mA), which is pretty low compared to other devices (just over $20 per year). It’s about the same as a bedroom clock radio…
Recent builds of Quake On LAN include a sort of API that will allow control of the Raspberry Pi via URLs in your browser. This is useful if your router is some distance from where the game is happening, or getting to it is not so easy right now! The current list of commands is as follows:
/reboot (reboot the Raspberry Pi – be sure to close browser window afterwards to avoid a reboot loop!)
/shutdown (shutdown the Raspberry Pi)
/quake/map/list (list all available maps for QuakeWorld)
/quake/map/upload (upload a custom map for QuakeWorld)
/quake/ctf (restart, or switch QuakeWorld server to, Capture The Flag mode)
/quake/dm (restart, or switch QuakeWorld server to, Deathmatch mode)
/quake/config (modify the default QuakeWorld server config file)
/quake/bots (restart, or switch QuakeWorld server to, Botmatch mode)
/quake2/map/list (list all available maps for Quake 2)
/quake2/map/upload (upload a custom map for Quake 2)
/quake2/ctf (restart, or switch Quake 2 server to, Capture The Flag mode)
/quake2/dm (restart, or switch Quake 2 server to, Deathmatch mode)
/quake2/config (modify the default Quake 2 server config file)
/quake2/lithium (restart, or switch Quake 2 server to, Lithium II mode)
/quake2/duel (restart, or switch Quake 2 server to, Tourney/Duel mode using custom maps)
/quake2/bots (information about Quake 2 Botmatch mode)
/quake3/map/list (list all available maps for Quake III Arena)
/quake3/map/upload (upload a custom map for Quake III Arena)
/quake3/ctf (restart, or switch Quake III Arena server to, Capture The Flag mode – with custom maps)
/quake3/dm (restart, or switch Quake III Arena server to, Deathmatch mode – demo maps only)
/quake3/config (modify the default Quake III Arena server config file)
/quake3/duel (restart, or switch Quake III Arena server to, Tourney/Duel mode using custom maps)
/quake3/unlock (unlock the maps that come with Quake III Arena retail version, if you own it)
For example, you could restart the Raspberry Pi by visiting http://10.2.2.185/reboot – if 10.2.2.185 is your server IP address.
We will hopefully be adding to this list in future releases.