How to setup a local QuakeJS server under Windows 10

From steamWiki
Revision as of 09:34, 9 September 2019 by Sean (talk | contribs) (Created page with "'''TLDR:''' This ''How To'' will show you how to setup a local QuakeJS server, local Play page (for users to connect to the local server), and a local content server (to provi...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

TLDR: This How To will show you how to setup a local QuakeJS server, local Play page (for users to connect to the local server), and a local content server (to provide files to the clients) under Windows 10. It is based off of my original guide using Debian.

I found myself in a situation where I was going to be on a LAN without internet access for an extended period of time along with multiple people and multiple computers. I wanted a fun, fast paced, multiplayer game for us. The catch? I didn't want anyone to have to install anything since these computers didn't belong to us. That's a pretty tall order. What I found was QuakeJS. Quake 3 was open sourced at the beginning of 2012 and some awesome dudes based ioquake3 off of it. Another awesome dude created QuakeJS around 2013/2014. QuakeJS allows you to play Quake 3 entirely in a browser.

The source code has instructions for creating a dedicated server as well as building from source & generating assets for a content server (under Linux). Unfortunately the Emscripten tool used to build the project has changed the way it operates in since 2014 and the current version of the QuakeJS source doesn't build with modern versions of Emscripten. Luckily Inolen provided the precompile .js files for those of us just wanting to run a server. Between those .js files, the QuakeJS README, some helpful discussion on how to setup a local webpage to connect to the server (as well as providing the content necessary to play) and a bit of tinkering, I've been successful in creating a server environment that I'm happy with.

NOTE: This guide assumes your local server's hostname is "quakejs"

Install Node.js & NPM

  1. Visit https://nodejs.org and download the latest .msi installer for Node.js (v12.10.0 at the time of this writing)
  2. Run the .msi to install Node.js & NPM
    1. Click Next to start the install
    2. Click Accept & Next to accept the license
    3. Click Next to accept the default installation folder
    4. Click Next to accept the default options
    5. quakejs doesn't require any of the "extra tools" but you can install them if you want by checking the box on this screen. Click Next
    6. Accept the Windows pop-up and wait for the install to complete
    7. Click Finish
  3. You can test this installation by opening a Command Prompt and running
    node -v

Install Git

  1. Visit https://git-scm.com/download/win to automatically start the download of the latest Windows version of the Git client (v2.23.0 at the time of this writing)
  2. Run the downloaded .exe file to launch the installer
    1. Click Yes to start install
    2. Click Next to accept the license agreement
    3. Click Next to accept the default install location
    4. Click Next to accept the default options
    5. Click Next to allow the installer to create Start Menu links
    6. Select your preferred text editor (I like Notepad++ on Windows)
    7. Click Next to accept the default PATH option
    8. Click Next to use OpenSSL
    9. Click Next to use the default line ending option
    10. Click Next to use MinTTY
    11. Click Next to accept the default extra options
    12. Click Next to skip the experimental features and wait for the install to complete
    13. Click Finish
  3. You can test this installation by opening a Command Prompt and running
    git --version</pr>

Install Extra Git Bash Packages

  1. Visit https://stedolan.github.io/jq/download/ and download the latest jq executable for Windows (v1.6 at the time of this writing)
    • Make sure you get the correct 32-bit or 64-bit version for your OS
  2. Rename the downloaded file (either jq-win64.exe or jq-win32.exe) to jq.exe
  3. Visit https://eternallybored.org/misc/wget/ and download the latest wget executable for Windows (v1.20.3 at the time of this writing)
    • Make sure you get the correct 32-bit or 64-bit version for your OS
  4. copy jq.exe & wget.exe from your Downloads folder to C:\Program Files\Git\mingw64\bin\