Difference between revisions of "How to setup a local QuakeJS server under Debian 9 or Debian 10"

From steamWiki
Jump to: navigation, search
(Setup a Local Play Page)
(5 intermediate revisions by the same user not shown)
Line 34: Line 34:
 
#Create a baseq3 server config file by running the following command <pre>nano base/baseq3/server.cfg</pre> and fill in the body with the following <pre>seta sv_hostname "quakejs"&#10;seta sv_maxclients 12&#10;seta g_motd "Welcome to the Local baseq3 QuakeJS Server"&#10;seta g_quadfactor 3&#10;seta g_gametype 0&#10;seta timelimit 15&#10;seta fraglimit 25&#10;seta g_weaponrespawn 3&#10;seta g_inactivity 3000&#10;seta g_forcerespawn 0&#10;seta rconpassword "quakejs"&#10;set d1 "map q3dm7 ; set nextmap vstr d2"&#10;set d2 "map q3dm17 ; set nextmap vstr d1"&#10;vstr d1</pre>Make sure you change the password in '''seta rconpassword'''
 
#Create a baseq3 server config file by running the following command <pre>nano base/baseq3/server.cfg</pre> and fill in the body with the following <pre>seta sv_hostname "quakejs"&#10;seta sv_maxclients 12&#10;seta g_motd "Welcome to the Local baseq3 QuakeJS Server"&#10;seta g_quadfactor 3&#10;seta g_gametype 0&#10;seta timelimit 15&#10;seta fraglimit 25&#10;seta g_weaponrespawn 3&#10;seta g_inactivity 3000&#10;seta g_forcerespawn 0&#10;seta rconpassword "quakejs"&#10;set d1 "map q3dm7 ; set nextmap vstr d2"&#10;set d2 "map q3dm17 ; set nextmap vstr d1"&#10;vstr d1</pre>Make sure you change the password in '''seta rconpassword'''
 
#Optionally create a cpma server config file by running the following command <pre>nano base/cpma/server.cfg</pre> and fill in the body with the following <pre>seta sv_hostname "quakejs"&#10;seta sv_maxclients 12&#10;seta g_motd "Welcome to the Local cpma QuakeJS Server"&#10;seta g_quadfactor 3&#10;seta g_gametype 0&#10;seta timelimit 15&#10;seta fraglimit 25&#10;seta g_weaponrespawn 3&#10;seta g_inactivity 3000&#10;seta g_forcerespawn 0&#10;seta rconpassword "quakejs"&#10;set d1 "map q3dm7 ; set nextmap vstr d2"&#10;set d2 "map q3dm17 ; set nextmap vstr d1"&#10;vstr d1</pre>Make sure you change the password in '''seta rconpassword'''
 
#Optionally create a cpma server config file by running the following command <pre>nano base/cpma/server.cfg</pre> and fill in the body with the following <pre>seta sv_hostname "quakejs"&#10;seta sv_maxclients 12&#10;seta g_motd "Welcome to the Local cpma QuakeJS Server"&#10;seta g_quadfactor 3&#10;seta g_gametype 0&#10;seta timelimit 15&#10;seta fraglimit 25&#10;seta g_weaponrespawn 3&#10;seta g_inactivity 3000&#10;seta g_forcerespawn 0&#10;seta rconpassword "quakejs"&#10;set d1 "map q3dm7 ; set nextmap vstr d2"&#10;set d2 "map q3dm17 ; set nextmap vstr d1"&#10;vstr d1</pre>Make sure you change the password in '''seta rconpassword'''
#You can run your server with the following command, but the isn't much point until we setup the Content Server and Play Page. <pre>node build/ioq3ded.js +set fs_game baseq3 set dedicated 1 +exec server.cfg</pre>
+
#You can test (or run) your server with the following command, but the isn't much point until we setup the Content Server and Play Page. <pre>node build/ioq3ded.js +set fs_game baseq3 set dedicated 1 +exec server.cfg</pre>
  
 
==Setup a Local Content Server==
 
==Setup a Local Content Server==
Line 50: Line 50:
 
#Download a copy of the [https://en.wikipedia.org/wiki/Cascading_Style_Sheets CSS] used to format the Play Page and it where it goes by running <pre>sudo wget -O /var/www/html/game.css http://www.quakejs.com/css/ff3bfe05fa66a6c5418f2f02b0e55e36-game.css</pre>
 
#Download a copy of the [https://en.wikipedia.org/wiki/Cascading_Style_Sheets CSS] used to format the Play Page and it where it goes by running <pre>sudo wget -O /var/www/html/game.css http://www.quakejs.com/css/ff3bfe05fa66a6c5418f2f02b0e55e36-game.css</pre>
 
#Download a copy of the [https://en.wikipedia.org/wiki/JavaScript JS] and put it where it goes by running <pre>sudo wget -O /var/www/html/ioquake3.js http://www.quakejs.com/js/38cbed8aa9a0bda4736d1aede69b4867-ioquake3.js</pre>
 
#Download a copy of the [https://en.wikipedia.org/wiki/JavaScript JS] and put it where it goes by running <pre>sudo wget -O /var/www/html/ioquake3.js http://www.quakejs.com/js/38cbed8aa9a0bda4736d1aede69b4867-ioquake3.js</pre>
 +
#Download a copy of the favicons by running <pre>sudo wget -O /var/www/html/quakejs_favicons.tar.gz http://steamforge.net/files/quakejs/quakejs_favicons.tar.gz</pre>
 +
#Extract the favicons by running <pre>sudo tar -xvzf /var/www/html/quakejs_favicons.tar.gz</pre>
 +
#Remove the compressed file by running <pre>sudo rm /var/www/html/quakejs_favicons.tar.gz</pre>
 
#Modify the Play Page you downloaded to make it suitable for running locally by running the following command and making the change specified below <pre>sudo nano /var/www/html/index.html</pre>
 
#Modify the Play Page you downloaded to make it suitable for running locally by running the following command and making the change specified below <pre>sudo nano /var/www/html/index.html</pre>
 
##Change Line 4 to say whatever you want, something like <pre><title>QuakeJS Local</title></pre>
 
##Change Line 4 to say whatever you want, something like <pre><title>QuakeJS Local</title></pre>
##Change Line 5 to <pre><link rel="stylesheet" href="game.css"></link></pre>
+
##Change Line 5 to <pre><link rel="stylesheet" href="/game.css"></link></pre>
##Change Line 6 to <pre><script type="text/javascript" src="ioquake3.js"></script></pre>
+
##Change Line 6 to <pre><script type="text/javascript" src="/ioquake3.js"></script></pre>
 
##Comment out Lines 7 through 16 to disable Google Analytics
 
##Comment out Lines 7 through 16 to disable Google Analytics
 
###Change Line 7 to <pre><!-- <script type="text/javascript"></pre>
 
###Change Line 7 to <pre><!-- <script type="text/javascript"></pre>
 
###Change Line 16 to <pre></script> --></pre>
 
###Change Line 16 to <pre></script> --></pre>
 
##Change Line 75 to <pre>var args = ['+set', 'fs_cdn', 'quakejs:80', '+connect', 'quakejs:27960'];</pre>
 
##Change Line 75 to <pre>var args = ['+set', 'fs_cdn', 'quakejs:80', '+connect', 'quakejs:27960'];</pre>
 +
##Add the following between lines 6 and 7 <pre><link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">&#10;<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">&#10;<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">&#10;<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">&#10;<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">&#10;<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">&#10;<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">&#10;<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">&#10;link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">&#10;<link rel="icon" type="image/png" sizes="192x192"  href="/android-icon-192x192.png">&#10;<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">&#10;<link rel="icon" type="image/png" sizes="96x96" href="/favicon-96x96.png">&#10;<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">&#10;<link rel="manifest" href="/manifest.json">&#10;<meta name="msapplication-TileColor" content="#ffffff">&#10;<meta name="msapplication-TileImage" content="/ms-icon-144x144.png">&#10;<meta name="theme-color" content="#ffffff"></pre>
  
 
At this point you can visit http://quakejs/ and it will download a couple files to your browser from your local content server and connect to your server (if it is running, which it isn't if you're following this guide).
 
At this point you can visit http://quakejs/ and it will download a couple files to your browser from your local content server and connect to your server (if it is running, which it isn't if you're following this guide).
Line 78: Line 82:
  
 
Get a few friends together, have them point their browsers to http://quakejs/ and start fragging!
 
Get a few friends together, have them point their browsers to http://quakejs/ and start fragging!
 +
 +
=References=
 +
*https://github.com/inolen/quakejs/blob/master/README.md
 +
*https://github.com/inolen/quakejs/issues/19
 +
  
 
[[Category: Linux]]
 
[[Category: Linux]]

Revision as of 10:52, 12 July 2019

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).

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. 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.

The theory is pretty simple

  1. Follow Inolen's original instructions for setting up a QuakeJS server
  2. Download everything we might need from the content server http://content.quakejs.com and rehost it locally
  3. Download the source code (and referenced CSS & JS files) from http://www.quakejs.com/play, modify them for local use, and rehost them locally
  4. Setup Debian to launch our server on boot
  5. Frag

Below I'm going to break it down step by step

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

Prepare your Machine

  1. Make sure our system is up to date before we start by running
    sudo apt update
    and
    sudo apt upgrade
  2. Create a dedicated user to run our server with
    sudo adduser quake
  3. Temporarily give quake sudo access to make setup easier (we'll remove it later) by running
    sudo usermod -aG sudo quake
  4. Switch to our new quake user and start in his home directory by running
    su - quake

Setup a Local QuakeJS Server

  1. Install curl by running
    sudo apt install curl
  2. Add the repo for node.js by running
    curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
  3. Install the tools we need to setup our server by running
    sudo apt install git nodejs
  4. Make sure we're in our home directory by running
    cd ~
  5. Clone the original QuakeJS git repository (along with the ioq3 repository sub-module) by running
    git clone --recurse-submodules https://github.com/inolen/quakejs.git
  6. Move into the newly created quakejs directory by running
    cd quakejs
  7. Install the necessary node.js packages by running
    npm install
    You'll see some warnings about deprecated packages and vulnerabilities. You'll have to just accept it and move on. QuakeJS is from 2013/2014.
  8. To download BASE3Q files, run the server for the 1st time by executing the following command. Hold down enter to get through the EULA, agree to the EULA by hitting y and game files will be downloaded. Once all files have been downloaded (you'll see the line ignoring setsockopt command) quit the server by hitting Ctrl+C
    node build/ioq3ded.js +set fs_game baseq3 +set dedicated 1
  9. Optionally run the following command to download additional CPMA files. Again hit Ctrl+C to quit the server once all files have been downloaded (you'll see the line ignoring setsockopt command)
    node build/ioq3ded.js +set fs_game cpma +set dedicated 1
  10. Create a baseq3 server config file by running the following command
    nano base/baseq3/server.cfg
    and fill in the body with the following
    seta sv_hostname "quakejs"
    seta sv_maxclients 12
    seta g_motd "Welcome to the Local baseq3 QuakeJS Server"
    seta g_quadfactor 3
    seta g_gametype 0
    seta timelimit 15
    seta fraglimit 25
    seta g_weaponrespawn 3
    seta g_inactivity 3000
    seta g_forcerespawn 0
    seta rconpassword "quakejs"
    set d1 "map q3dm7 ; set nextmap vstr d2"
    set d2 "map q3dm17 ; set nextmap vstr d1"
    vstr d1
    Make sure you change the password in seta rconpassword
  11. Optionally create a cpma server config file by running the following command
    nano base/cpma/server.cfg
    and fill in the body with the following
    seta sv_hostname "quakejs"
    seta sv_maxclients 12
    seta g_motd "Welcome to the Local cpma QuakeJS Server"
    seta g_quadfactor 3
    seta g_gametype 0
    seta timelimit 15
    seta fraglimit 25
    seta g_weaponrespawn 3
    seta g_inactivity 3000
    seta g_forcerespawn 0
    seta rconpassword "quakejs"
    set d1 "map q3dm7 ; set nextmap vstr d2"
    set d2 "map q3dm17 ; set nextmap vstr d1"
    vstr d1
    Make sure you change the password in seta rconpassword
  12. You can test (or run) your server with the following command, but the isn't much point until we setup the Content Server and Play Page.
    node build/ioq3ded.js +set fs_game baseq3 set dedicated 1 +exec server.cfg

Setup a Local Content Server

  1. Setup a webserver to host our content and install jq to help with downloading assets by running
    sudo apt install apache2 jq
  2. change directories to where our web files are hosted by running
    cd /var/www/html/
  3. Download a script that I wrote to simplify getting the assets from http://content.quakejs.com by Running
    sudo wget https://steamforge.net/files/quakejs/get_assets.sh
  4. Make the script executable by running
    sudo chmod +x get_assets.sh
  5. Run the script to grab all of the assets from http://content.quakejs.com and put them where they can be accessed by clients. (Technically you already downloaded a couple of the files earlier but they aren't named quite right and we'll download everything from the "official" content server in one go to simplify things).
    sudo bash get_assets.sh
    This will put all of the asset files where they need to go in /assets.
  6. Optionally remove get_assets.sh by running
    sudo rm get_assets.sh

Setup a Local Play Page

  1. If you didn't already install Apache2 for the content server, do it now by running
    sudo apt install apache2
  2. Delete the default index.html that comes with Apache2 by running
    sudo rm /var/www/html/index.html
  3. Download a copy of the Play Page from the QuakeJS website and put it where it can be accessed locally by running
    sudo wget -O /var/www/html/index.html http://www.quakejs.com/play
  4. Download a copy of the CSS used to format the Play Page and it where it goes by running
    sudo wget -O /var/www/html/game.css http://www.quakejs.com/css/ff3bfe05fa66a6c5418f2f02b0e55e36-game.css
  5. Download a copy of the JS and put it where it goes by running
    sudo wget -O /var/www/html/ioquake3.js http://www.quakejs.com/js/38cbed8aa9a0bda4736d1aede69b4867-ioquake3.js
  6. Download a copy of the favicons by running
    sudo wget -O /var/www/html/quakejs_favicons.tar.gz http://steamforge.net/files/quakejs/quakejs_favicons.tar.gz
  7. Extract the favicons by running
    sudo tar -xvzf /var/www/html/quakejs_favicons.tar.gz
  8. Remove the compressed file by running
    sudo rm /var/www/html/quakejs_favicons.tar.gz
  9. Modify the Play Page you downloaded to make it suitable for running locally by running the following command and making the change specified below
    sudo nano /var/www/html/index.html
    1. Change Line 4 to say whatever you want, something like
      <title>QuakeJS Local</title>
    2. Change Line 5 to
      <link rel="stylesheet" href="/game.css"></link>
    3. Change Line 6 to
      <script type="text/javascript" src="/ioquake3.js"></script>
    4. Comment out Lines 7 through 16 to disable Google Analytics
      1. Change Line 7 to
        <!-- <script type="text/javascript">
      2. Change Line 16 to
        </script> -->
    5. Change Line 75 to
      var args = ['+set', 'fs_cdn', 'quakejs:80', '+connect', 'quakejs:27960'];
    6. Add the following between lines 6 and 7
      <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
      <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
      <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
      <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
      <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
      <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
      <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
      <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
      link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
      <link rel="icon" type="image/png" sizes="192x192"  href="/android-icon-192x192.png">
      <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
      <link rel="icon" type="image/png" sizes="96x96" href="/favicon-96x96.png">
      <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
      <link rel="manifest" href="/manifest.json">
      <meta name="msapplication-TileColor" content="#ffffff">
      <meta name="msapplication-TileImage" content="/ms-icon-144x144.png">
      <meta name="theme-color" content="#ffffff">

At this point you can visit http://quakejs/ and it will download a couple files to your browser from your local content server and connect to your server (if it is running, which it isn't if you're following this guide).

Run the server manually by running
cd /home/quake/quakejs
node build/ioq3ded.js +set fs_game baseq3 set dedicated 1 +exec server.cfg
or finish off this guide to create a service that you can start with
sudo systemctl start quakejs
and that will auto start on boot.

Finalize the Setup

  1. Configure Debian to autorun our server on boot
    1. Install daemonize (for use in our init.d script) by running
      sudo apt install daemonize
    2. Create a new service file by running
      sudo nano /etc/init.d/quakejs
    3. Fill the file with the following
      #!/bin/sh
      #
      ### BEGIN INIT INFO
      # Provides:		quakejs
      # Required-Start:	$network
      # Required-Stop:
      # Default-Start:	2 3 4 5
      # Default-Stop:
      # Short-Description:	QuakeJS Server Daemon
      ### END INIT INFO
      
      #
      # /etc/init.d/quakejs
      # Subsystem file for "quakejs" server
      #
      # chkconfig: 2345 95 05
      # description: QuakeJS server daemon
      #
      # processname: quakejs
      # pidfile: /var/run/quakejs.pid
      
      RETVAL=0
      prog="quakejs"
      
      start() {
      	echo "Starting $prog:"
      	daemonize -v -p /var/run/$prog.pid -c /home/quake/quakejs -u quake /usr/bin/node build/ioq3ded.js +set fs_game baseq3 set dedicated 1 +exec server.cfg
      	RETVAL=$?
      	[ "$RETVAL" = 0 ] && touch /var/lock/subsys/$prog
      	echo
      }
      
      stop() {
      	echo "Stopping $prog:"
      	killproc $prog -TERM
      	RETVAL=$?
      	[ "$RETVAL" = 0 ] && rm -f /var/lock/subsys/$prog
      	echo
      }
      
      case "$1" in
      	start)
      		start
      		;;
      	stop)
      		stop
      		;;
      	restart)
      		stop
      		sleep 3
      		start
      		;;
      	condrestart)
      		if [ -f /var/lock/subsys/$prog ] ; then
      			stop
      			# avoid race
      			sleep 3
      			start
      		fi
      		;;
      	status)
      		status $prog
      		RETVAL=$?
      		;;
      	*)
      		echo $"Usage: $0 {start|stop|restart|condrestart|status}"
      		RETVAL=1
      esac
      exit $RETVAL
      
    4. Make our new file executable by running
      sudo chmod +x /etc/init.d/quakejs
    5. Enable it by running
      sudo update-rc.d quakejs defaults
    6. You can test this by running
      sudo systemctl start quakejs
      and/or rebooting your machine by running
      sudo reboot
  2. Lastly we need to remove sudo privileges from user quake
    1. Get back to our original sudo user (not quake) by running the following command which undoes su - quake
      exit
    2. Remove quake from the sudo group by running
      sudo gpasswd -d quake sudo

That's it! Whenever your quakejs server boots up it will automatically start the quakejs game server and Apache2 webserver. When a computer on your LAN visits http://quakejs/ they'll automatically download the files they need from http://quakejs/assets/ and then connect to the QuakeJS server at quakejs:27960.

Get a few friends together, have them point their browsers to http://quakejs/ and start fragging!

References