Skip to content

pnnl/pupate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

145 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MOTH Pupate

This converts MOTH categories into MOTH puzzle directories, or SCTR trainings.

Full documentation is in the docs directory. This is also served under the URL /docs/ by pupate.

Getting Started

  1. Run the cocoon command
  2. Open http://localhost:8080 and navigate to the 1-point puzzle in the counting category.
  3. In your Documents folder is a new categories folder. Open categories/counting/1/puzzle.md in a text editor like Visual Studio Code, vim, or emacs.
  4. Add some text to the bottom of the file and save it.
  5. Check back in your web browser to see what it did.

Commands

cocoon

cocoon is a web-based debugging tool to monitor and render collections of categories. Run it with no options to get started.

By default, it will watch your filesystem for changes to your files. If your filesystem does not support a notification mechanism (NFS, SMB), you will need to provide a -poll option.

pupate

pupate is an interactive tool to convert puzzle directories.

moth2md

moth2md converts legacy .moth files to modern .md files.

Why?

We (the Cyber Fire team) like writing puzzles in Markdown, and storing everything in version control. We also think it's handy to keep one puzzle's metadata tightly bundled with that puzzle.

For architectural reasons, both MOTH and SCTR pull various fields, such as what are the "answers", out of the puzzle itself. Pupate allows creators to focus on logically bundling things together, and letting the compile step worry about how to bring that into production.

About the name

Moths and butterflies go through four life stages: egg, larva (caterpillar), pupa (chrysalis or cocoon), and adult. Keeping with the moth theme, this program is used to transform puzzle source into a production puzzle.

The icon for this project is "silk-cocoon_2849891", created by "Eucalyp" on flaticon.com. It was provided for free personal and commercial use with attribution. It's not included in the source code, though, so if you want it, you'll have to go download your own copy.


Information Release Number PNNL-SA-221926

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors