kjarosh/QuadradiusPreservationProject

Quadradius Preservation Project

The goal of this project is to keep this fantastic game alive by recreating core functionality of the server, which at this moment is limited (original available at Quadradius). The project is completely non-profit and should be considered as educational. All of the rights belong to the original authors, Jimmi Heiserman and Brad Kayal. The provided software does not represent the quality of the original, and the original authors should in no way be held accountable for any liabilities.

Progress

The current version can be considered early alpha. It is playable, although buggy and prone to crashes. Detailed progress is available here.

Requirements

Clients require Flash Player to work. The server runs on Python 3.7 or higher.

Installation and running

Clone or download the repository from GitHub and run

python -m QRServer

You can configure the server by passing the following CLI parameters:

• -b/--bind — bind address (default 127.0.0.1),
• -p/--lobby-port — lobby port (default 3000),
• -q/--game-port — game port (default 3001).

You can also run python -m QRServer -h to display help.

Docker

This repository also contains a Dockerfile which creates an image with an HTTP server (serving the client SWF files), and the QR server itself.

1. Build the image

   docker build . -t quadradius-server

2. Run the image

   docker run -it \
     -p 3000:3000 \
     -p 3001:3001 \
     -p 8000:8000 \
     quadradius-server

You can define the following environment variables to configure the server:

• ADDRESS — the address which the server will be hosted at, by default it's 127.0.0.1
• LOBBY_PORT and GAME_PORT — the ports of the application, they are used by the client to connect to the server

When the image is running, you can start the game by executing

./flashplayer http://<address>:<http port>/quadradius_lobby.swf

by default, it will be

./flashplayer http://127.0.0.1:8000/quadradius_lobby.swf