Monarch Of The Hill - base infrastructure for computer-based puzzle contests

Go to file

Neale Pickett 3b51593f2b Finazile example puzzles and document how to use them		2016-12-01 16:18:50 -07:00
docs	Github wants docs/, not doc/	2016-10-25 02:51:55 +00:00
example-puzzles/example	Finazile example puzzles and document how to use them	2016-12-01 16:18:50 -07:00
src	Puzzle.randword, don't escape HTML, change mono font	2016-11-28 15:17:12 -07:00
tools	Puzzle.randword, don't escape HTML, change mono font	2016-11-28 15:17:12 -07:00
.gitignore	Reworked some basics of how the Puzzle class works. Shouldn't look to different from the outside.	2016-10-17 13:24:54 -06:00
README.md	Github wants docs/, not doc/	2016-10-25 02:51:55 +00:00
install	Changed points restore output to Neale's stupid space delimited format. Added url param 'snapshot' to specify a points snapshot to restore (0-19). Changed points log storage to an array of the 20 most recent points logs.	2015-05-28 14:15:05 -06:00
package-puzzles	First pass cleanup, still broken	2016-10-25 02:57:31 +00:00
setup.cfg	devel-server use new Puzzles obj. Needs cleanup.	2016-10-18 05:02:05 +00:00

README.md

Dirtbags Monarch Of The Hill Server

This is a set of thingies to run our Monarch-Of-The-Hill contest, which in the past has been called "Tracer FIRE", "Project 2", "HACK", "Queen Of The Hill", "Cyber Spark", and "Cyber Fire".

Information about these events is at http://dirtbags.net/contest/

This software serves up puzzles in a manner similar to Jeopardy. It also tracks scores, and comes with a JavaScript-based scoreboard to display team rankings.

How everything works

This section wound up being pretty long. Please check out the overview for details.

Getting Started Developing

$ git clone $your_puzzles_repo puzzles
$ python3 tools/devel-server.py

Then point a web browser at http://localhost:8080/ and start hacking on things in your puzzles directory.

More on how the devel sever works in the devel server documentation

Running A Production Server

XXX: Update this

How to set it up

It's made to be virtualized, so you can run multiple contests at once if you want. If you were to want to run it out of /opt/koth, do the following:

$ mkdir -p /opt/koth/mycontest
$ ./install /opt/koth/mycontest
$ cp kothd /opt/koth

Yay, you've got it set up.

Installing Puzzle Categories

Puzzle categories are distributed in a different way than the server. After setting up (see above), just run

$ /opt/koth/mycontest/bin/install-category /path/to/my/category

Running It

Get your web server to serve up files from /opt/koth/mycontest/www.

Then run /opt/koth/kothd.

Permissions

It's up to you not to be a bonehead about permissions.

Install sets it so the web user on your system can write to the files it needs to, but if you're using Apache, it plays games with user IDs when running CGI. You're going to have to figure out how to configure your preferred web server.