Inlaserworld engine

Let’s build the best lasergame game scenarious and epic experiance ever.

Get started View it on github

Introduction

This is the documentation of Inlaserworld engine. It is the API which enables to create really custom game scenario. There are four main parts:

  • API for main unit also called arena written in C/C++.
  • API for device written in C.
  • API for online game results written in javascript/React
  • API for final game result written in javascript/Nodejs with PdfKit

APIs can handle various of scenarios and everything can be controlled. You become director of the game and you can create light or sounds efect, rules or just some funny stuff. The whole system is based on events e.g. somebody hit me what should I do? Play sound? decrement life? strobe effect? or just ignore it because shield was activated in previous time.

Instalation

We provide full featured simulation of our system. This enable anybody to create source code for game scenario debug it and publish it for review or just use it with real devices.

Of course there is an docker container including everything but unfortunately two linux kernel modules needs to be used. So only linux host is currently available for running docker container. Linux host can be virtualized using virtual box or e.g. AWS lightsail.

  • tty0tty we use it for simulation of xbee network used for communication with device.
  • vcan used for communication with static devices at arena e.g. control lights or bonuses.
# install packages
sudo apt-get update
sudo apt-get install git docker docker.io gcc make -y

# if AWS lightsail used 
sudo apt-get install linux-modules-extra-aws && sudo reboot

Install kernel headers

sudo apt-get install linux-headers-`uname -r`

Install tty0tty

git clone https://github.com/freemed/tty0tty.git
cd tty0tty/module
sed -i 's|static unsigned int tty0tty_write_room|static int tty0tty_write_room|g' tty0tty.c
make
sudo cp tty0tty.ko /lib/modules/$(uname -r)/kernel/drivers/misc/
sudo depmod
sudo modprobe tty0tty
sudo chmod 666 /dev/tnt*

Install vcan (every linux machine should have it by default)

sudo modprobe vcan
sudo ip link add dev vcan0 type vcan
sudo ip link set up vcan0

To load tty0tty and vcan after boot

sudo bash -c 'echo "#/bin/bash" > /etc/init.d/enableTty0.sh'
sudo bash -c 'echo "chmod 666 /dev/tnt*" >> /etc/init.d/enableTty0.sh'
sudo bash -c 'echo "ip link add dev vcan0 type vcan" >> /etc/init.d/enableTty0.sh'
sudo bash -c 'echo "ip link set up vcan0" >> /etc/init.d/enableTty0.sh'
sudo bash -c 'echo "tty0tty" >> /etc/modules'
sudo bash -c 'echo "vcan" >> /etc/modules'
sudo bash -c 'crontab -l | { cat; echo "@reboot /etc/init.d/enableTty0.sh"; } | crontab -'

If user is not already in group add it

sudo usermod -aG docker $USER
# Logout and login again

Image is currently hosted on private docker repository. To get credentials contact daniel.lazar@htdm.cz

docker login docker.htdm.net

Now finally let’s run docker

docker run -it --rm --hostname="$(hostname)" --publish="3389:3389/tcp" \
  --name="inlaserworldrdp" --shm-size="1g" --cap-add=NET_ADMIN \
  --security-opt apparmor=unconfined --privileged -p 7777:7777 -p 7778:7778 \
  docker.htdm.net/inlaserworldrdp:1.0 /bin/bash
# Optional if docker needs to keep live use --detach

Once docker is running continue to Simulation get started.