Monarch Of The Hill - base infrastructure for computer-based puzzle contests
Go to file
Neale Pickett 14b92fe617 Linter and spelling fixes 2020-09-17 19:48:17 -06:00
.github Rearrange directories and CI a little 2020-09-17 18:56:40 -06:00
.vscode mkpuzzle working in dev mode 2020-09-11 13:03:19 -06:00
build/package Rearrange directories and CI a little 2020-09-17 18:56:40 -06:00
cmd Linter and spelling fixes 2020-09-17 19:48:17 -06:00
contrib Bit of reorg, add missing files 2019-08-25 07:10:32 -06:00
docs Tidy go mod, move to docs 2020-09-11 21:26:07 -06:00
example-puzzles Standardize cat/puzzle command args 2020-09-14 18:23:56 -06:00
pkg Linter and spelling fixes 2020-09-17 19:48:17 -06:00
theme Wrap overflow in developer box 2020-09-15 10:08:19 -06:00
.dockerignore Housekeeping 2020-09-17 19:35:46 -06:00
.gitignore Housekeeping 2020-09-17 19:35:46 -06:00
CHANGELOG.md Rearrange directories and CI a little 2020-09-17 18:56:40 -06:00
CONTRIBUTING.md @nealey 's spelling is impractical 2020-02-21 21:25:13 +00:00
LICENSE.md License formatting 2019-08-25 07:20:17 -06:00
README.md Rearrange directories and CI a little 2020-09-17 18:56:40 -06:00
TODO.md mkpuzzle working in dev mode 2020-09-11 13:03:19 -06:00
go.mod Housekeeping 2020-09-17 19:35:46 -06:00
go.sum Housekeeping 2020-09-17 19:35:46 -06:00

README.md

Dirtbags Monarch Of The Hill Server

Build badge Go report card

Monarch Of The Hill (MOTH) is a puzzle server. We (the authors) have used it for instructional and contest events called "Tracer FIRE", "Project 2", "HACK", "Queen Of The Hill", "Cyber Spark", "Cyber Fire", "Cyber Fire Puzzles", and "Cyber Fire Foundry".

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

A few things make MOTH different than other Capture The Flag server projects:

  • Once any team opens a puzzle, all teams can work on it (high fives to DC949/Orange County for this idea)
  • No penalties for wrong answers
  • No time-based point deductions (if you're faster, you get to answer more puzzles)
  • No internal notion of ranking or score: it only stores an event log, and scoreboards parse it however they want
  • All puzzles must be compiled to static content before it can be served up
  • The server does very little: most functionality is in client-side JavaScript

You can read more about why we made these decisions in philosophy.

Documentation

  • Development: The development server lets you create and test categories, and compile mothballs.
  • Getting Started: This guide will get you started with a production server.
  • Administration: How to set hours, and change setup.

Running a Production Server

docker run --rm -it -p 8080:8080 -v /path/to/moth/state:/state -v /path/to/moth/mothballs:/mothballs:ro dirtbags/moth

You can be more fine-grained about directories, if you like. Inside the container, you need the following paths:

  • /state (rw) Where state is stored. Read the overview to learn what's what in here.
  • /mothballs (ro) Mothballs (puzzle bundles) as provided by the development server.
  • /theme (ro) Overrides for the built-in theme.

Contributing to MOTH

Please read CONTRIBUTING.md