Monarch Of The Hill - base infrastructure for computer-based puzzle contests
Go to file
Neale Pickett bff3dcd1cc Have puzzles.cgi handle categories with dashes 2015-04-21 09:02:25 -06:00
bin Onle reset one 2015-04-21 07:59:35 -06:00
doc Installation script 2015-04-09 17:40:03 -06:00
www Have puzzles.cgi handle categories with dashes 2015-04-21 09:02:25 -06:00
.gitignore tweak scoreboard 2012-02-02 16:51:19 -07:00
README Bugfixes (thanks civ) 2015-04-13 13:14:40 -06:00
TODO Lua-based puzzle lister 2015-04-19 22:57:35 -06:00
install Fully working and somewhat tested, with lua 2015-04-20 10:11:38 -06:00
kothd I actually tried running kothd this time 2015-04-13 13:23:10 -06:00

README

Dirtbags King Of The Hill Server
=====================

This is a set of thingies to run our KOTH-style contest.
Contests we've run in the past have been called
"Tracer FIRE" and "Project 2".

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


How Everything Works
----------------------------

I should fill this in, but I don't feel like anybody would read it.
Send an email to <neale@woozle.org> asking me how it works,
and I'll write this part up and email it back to you :)


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.