Tech demos

ioq3

As a demo, we have added O7s support to the ioq3 game engine. ioq3 is a fork of ID software’s Quake III Arena GPL Source Release. The port is available as a patch. The servers currently only work in dedicated mode (there is no way yet to start a server from the client).

To get the demo, first get the latest ioq3 sources:

$ git clone https://github.com/ioquake/ioq3.git
$ cd ioq3

Copy the patch via the link above, or get it via wget:

$ wget https://ouroboros.rocks/patches/ouroboros-ioq3.patch

Apply the patch to the ioq3 code:

$ git apply ouroboros-ioq3.patch

With Ouroboros installed, build the ioq3 project in standalone mode:

$ STANDALONE=1 make

You may need to install some dependencies like SDL2, see the ioq3 documentation.

The ioq3 project only supplies the game engine. To play Quake III Arena, you need the original game files and a valid key. Various open source games make use of the engine. We will detail the procedure for running OpenArena in your ioq3 build directory.

Go to your build directory:

$ cd build/<release_dir>/

To run OpenArena, you only need to the game files. First download the zip archive (openarena-0.8.8.zip) from the OpenArena website (or via wget) and then extract the baseoa folder:

$ wget http://www.openarena.ws/request.php?4 -O openarena-0.8.8.zip
$ unzip -j openarena-0.8.8.zip 'openarena-0.8.8/baseoa/*' -d ./baseoa

Make sure you have a local Ouroboros layer running in your system (see this tutorial).

To test the game, start a server (replace with the correct architecture extension for your machine, eg x86_64):

$ ./ioq3ded.<arch> +set com_basegame baseoa +map aggressor

Bind the pid of the server to a name and register it in the local layer:

$ irm bind proc <pid> name my.ioq3.server
$ irm name reg my.ioq3.server layer <your_local_layer>

To connect, start a client (in a different terminal):

$ ./ioquake3.<arch> +set com_basegame baseoa

When the client starts, go to the console by typing ~ (tilde) and enter the following command

connect -O my.ioq3.server

The client should now connect to the ioq3 dedicated server over Ouroboros. Register the name in non-local layers to connect from other machines. Happy Fragging!

netcat

Ouroboros-netcat instructions:

Clone the repo (somewhere):

git clone https://github.com:dstaesse/netcat
cd netcat

To compile this Ouroboros version:

LIBS=-louroboros-dev ./configure

Or, to enable debugging output (the netcat -d flag):

LIBS=-louroboros-dev ./configure --enable-debug=yes

And give it a simple "make" command:

make

Ouroboros support is toggled with the -O flag.

To start netcat in Ouroboros listen mode (assuming you are in the src/ folder):

./netcat -Ol

To send some data to the netcat instance:

./netcat -Oc <name>

Brief example over the "local" IPCP (you may need up to 3 terminal windows).

#start the irmd
sudo irmd --stdout

#create a "local" IPCP.
irm ipcp bootstrap type local name local layer local

# register the netcat name in the local layer
irm name register nc layer local        (be branch / upcoming version 0.17)

# bind the netcat program to <name>
irm bind prog ./netcat

# start an Ouroboros listen server (with some verbosity)
./netcat -Ovvl

# and from another terminal, send it a couple of bytes:
echo "Here's Johnny!" | ./netcat -Oc nc

# if all went well, you should see the following output on the server side
$ ./netcat -Ovvl
Flow received (new fd=64)
Here's Johnny!
^CExiting.
Total received bytes: 15
Total sent bytes: 0