Kaepora

The Ocarina of Time Randomizer leagues.

Goals:

• Provide a 1vs1 ladder for OoT randomizer races.
• Provide multiple leagues to compete with different settings.
• Web-first, Discord-second, easy to port on other messaging platforms.

Side-goals:

• Provide a framework for other randomized games to use for their ladder.
• Provide an OoT-specific randomizer settings randomizer (sic).

Non-goals and out of scope:

• Providing a generic tournament bot.

Configuration file

Located at: $XDG_CONFIG_HOME/kaepora/config.json

{

    "Discord": {
        "Token": "<optional (no bot)>",              // overriden by KAEPORA_DISCORD_TOKEN
        "ClientID": "<optional (no OAuth2)>",        // overriden by KAEPORA_DISCORD_CLIENT_ID
        "ClientSecret":  "<optional (no OAuth2)>",   // overriden by KAEPORA_DISCORD_CLIENT_SECRET
        "AdminUserIDs": ["<discord user id>"],
        "ListenIDs": ["<channel ID, set using !dev commands>"],
        "BannedUserIDs": ["<discord user id, manually inserted (TODO !dev ban)>"],
    },

    "CookieHashKey": "<secure random string (32 chars)>",  // overriden by KAEPORA_COOKIE_HASH_KEY
    "CookieBlockKey": "<secure random string (32 chars)>", // overriden by KAEPORA_COOKIE_BLOCK_KEY
    "OOTRAPIKey": "<optional (no remote seedgen)>"         // overriden by KAEPORA_OOTR_API_KEY
}

Having at least one admin ID is mandatory to make the bot listen to a channel and not only to PMs.

Build and run

$ # Install Go: https://golang.org/dl/
$ make
$ ./migrate -database sqlite3://kaepora.db -path resources/migrations up
$ ./kaepora fixtures
$ # Place ZOOTDEC.z64 and ARCHIVE.bin in the resources/oot-randomizer directory.
$ ./kaepora serve

To allow/disallow the bot to listen to a channel, send !dev addlisten or !dev removelisten in said channel.

Migrations

• Running migrations:

$ # Go to latest version:
$ ./migrate -database sqlite3://kaepora.db -path resources/migrations up
$ # Revert last migration:
$ ./migrate -database sqlite3://kaepora.db -path resources/migrations down 1

• Adding a migration:

$ ./migrate create -ext sql -dir resources/migrations -seq NAME