diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md index 433f658..89b2017 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,25 @@ This executable needs some parameters to work properly: | `-username` | No | Name of our user, as used e.g. in salutation. No length or charset limitation. *Default: Player 1* | | `-accessCode` | Yes | Access code for the user. *Default: AllYourCodesAreBelongToUs* | | `-sessionSalt` | Yes | Variable to salt the session token generator with. | +| `-seedFile` | Yes | JSON file to read challenge information from. | + +## Seed file + +The seed file should be of the following format: + +``` +{ + "challenges": [ + { + "name": "Evil Service", + "description": "A meaningful and funny description", + "flag": "CIRCUS[IS_REALLY_COOL]", + "container": "challenge-evilservice", + "category": "Miscellaneous" + }, + { + "name": "Insecure Stuff", + [...] + ] +} +``` |