github.com/dirtbags/moth/v4@v4.6.3-0.20240418162859-a93bc5be85d4/README.md (about)

     1  Dirtbags Monarch Of The Hill Server
     2  =====================
     3  
     4  [![Go report card](https://goreportcard.com/badge/github.com/dirtbags/moth)](https://goreportcard.com/report/github.com/dirtbags/moth)
     5  
     6  Monarch Of The Hill (MOTH) is a puzzle server.
     7  We (the authors) have used it for instructional and contest events called
     8  "Tracer FIRE",
     9  "Project 2",
    10  "HACK",
    11  "Queen Of The Hill",
    12  "Cyber Spark",
    13  "Cyber Fire",
    14  "Cyber Fire Puzzles",
    15  and "Cyber Fire Foundry".
    16  
    17  Information about these events is at
    18  http://dirtbags.net/contest/
    19  
    20  A few things make MOTH different than other Capture The Flag server projects:
    21  
    22  * Once any team opens a puzzle, all teams can work on it (high fives to DC949/Orange County for this idea)
    23  * No penalties for wrong answers
    24  * No time-based point deductions (if you're faster, you get to answer more puzzles)
    25  * No internal notion of ranking or score: it only stores an event log, and scoreboards parse it however they want
    26  * All puzzles must be compiled to static content before it can be served up
    27  * The server does very little: most functionality is in client-side JavaScript
    28  
    29  You can read more about why we made these decisions in [philosophy](docs/philosophy.md).
    30  
    31  
    32  Run in demonstration mode
    33  ===========
    34  
    35      docker run --rm -it -p 8080:8080 ghcr.io/dirtbags/moth-devel
    36  
    37  Then open http://localhost:8080/ and check out the example puzzles.
    38  
    39  
    40  Documentation
    41  ==========
    42  
    43  * [Development](docs/development.md): The development server lets you create and test categories, and compile mothballs.
    44  * [Getting Started](docs/getting-started.md): This guide will get you started with a production server.
    45  * [Administration](docs/administration.md): How to set hours, and change setup.
    46  
    47  
    48  
    49  Contributing to MOTH
    50  ==================
    51  
    52  Please read our [contributing guide](docs/CONTRIBUTING.md).