Giter VIP home page Giter VIP logo

kaepora's Introduction

Kaepora Build Status go report

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.