moth/README.md

54 lines
1.8 KiB
Markdown
Raw Normal View History

2016-01-31 20:45:35 -07:00
Dirtbags Monarch Of The Hill Server
2016-01-31 20:41:22 -07:00
=====================
2020-09-18 18:08:17 -06:00
![Build badge](https://github.com/dirtbags/moth/workflows/Build/Test/Push/badge.svg)
2020-09-17 18:56:40 -06:00
![Go report card](https://goreportcard.com/badge/github.com/dirtbags/moth)
Monarch Of The Hill (MOTH) is a puzzle server.
We (the authors) have used it for instructional and contest events called
2016-01-31 20:45:35 -07:00
"Tracer FIRE",
"Project 2",
"HACK",
"Queen Of The Hill",
2016-10-21 14:38:19 -06:00
"Cyber Spark",
2018-09-17 17:00:08 -06:00
"Cyber Fire",
"Cyber Fire Puzzles",
and "Cyber Fire Foundry".
2016-01-31 20:41:22 -07:00
2016-01-31 20:45:35 -07:00
Information about these events is at
http://dirtbags.net/contest/
A few things make MOTH different than other Capture The Flag server projects:
2016-01-31 20:41:22 -07:00
* 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
2016-01-31 20:41:22 -07:00
2020-09-11 21:26:07 -06:00
You can read more about why we made these decisions in [philosophy](docs/philosophy.md).
2018-09-20 10:15:34 -06:00
2019-06-11 16:58:15 -06:00
2020-09-18 18:19:22 -06:00
Run in demonstration mode
===========
docker run --rm -it -p 8080:8080 dirtbags/moth-devel
Then open http://localhost:8080/ and check out the example puzzles.
Documentation
==========
2018-09-20 10:15:34 -06:00
2020-09-11 21:26:07 -06:00
* [Development](docs/development.md): The development server lets you create and test categories, and compile mothballs.
* [Getting Started](docs/getting-started.md): This guide will get you started with a production server.
* [Administration](docs/administration.md): How to set hours, and change setup.
2018-09-20 10:15:34 -06:00
2018-09-17 17:00:08 -06:00
2019-12-17 10:48:22 -07:00
Contributing to MOTH
==================
2018-09-17 17:00:08 -06:00
Please read our [contributing guide](docs/CONTRIBUTING.md).