O876 RAYCASTER ENGINE

This is a Raycasting Engine aimed at building games based on raycasting and running on modern web browsers. This framework provides a WYSIWYG level editor hosted on an Express development server so you can immediatly start creating level.

Getting started

Prerequisites

You need :

• node.js installed (version 10.x). And npm.
• A web browser like Chrome, Chromium or Firefox. (The framework has not been tested on neither Edge nor Safari).

Installing

To include the framework in your game project, the installation procedure is currently :

npm install --save https://github.com/laboralphy/o876-raycaster-engine

As the framework contains hundreds of files you'll also need Webpack to build your own game project.

npm install --save-dev webpack webpack-cli

Running the tests

Tests are located at "./tests" and you just need to run :

npm test

Running the web server

There is a small embedded web server. It provides tools to get information and give access to the Map Editor (and creates your own levels). This web server is intended to work locally for game-development and level-design purpose.

To make it run, add a script in your package.json file.

{
  "scripts": {
    "serve": "o876-raycaster-engine"
  }
}

... then open a terminal and type :

node run serve

The terminal will output something like this :

> o876-raycaster-engine

---------------------------------
O876 Raycaster Engine Web Service
version: 1.3.0
Laboralphy
---------------------------------

action prefix /game
base location /home/ralphy/public_html/raycaster-es6
vault location : vault
game project location : game
server port : 8080
website url : http://localhost:8080/
service is now listening...

Open your web browser and go to the location written on the terminal output ; here : http://localhost:8080/

This will give you access a web page where you will be able to run demos, or running the map editor.

Web server configuration

You may add options to the script command line in order to configure :

• -p numeric value : sets the port value.
• -s path : sets the location of map editor save files.
• -g path : sets the location of the game project root directory.
• -x path : sets the game action prefix used by the server to build urls.

When you want to configure these parameters, modify your script section in your package.json file.

The following example will change the server port from 8080 to 4444 :

{
  "scripts": {
    "serve": "o876-raycaster-engine -p 4444"
  }
}