• Getting Started
  • Intro
  • Python Version
  • Command Line Interface
  • Web Interface
• Installation
  • Docker
  • Standard Install
• Running the Server
  • Development Server
  • Production Server
• Development
  • Typical Python/Backend Development
  • Advanced (Changing the bundled frontend code)
  • Build Docs
  • Run Unit Tests
• Configuration
  • Configuration Files
• Components
• Guided Tour of the Code
  • Basic Structure
  • Core Logic
    • thekraf.diceutils
    • thekraf.game
    • thekraf.gamemodels
    • thekraf.score
    • thekraf.utils
  • Database
    • thekraf.db
      • Overview
    • thekraf.db.listeners
    • thekraf.db.mapper
    • thekraf.db.models
  • Web
    • Init
      • thekraf.flaskapp
    • Views
      • thekraf.flaskapp.baseview
    • View Helpers
      • thekraf.flaskapp.fields
      • thekraf.flaskapp.formatters
      • thekraf.flaskapp.forms
      • thekraf.flaskapp.nav
      • thekraf.flaskapp.widgets
    • App
      • thekraf.flaskapp.app
    • Paths

thekraf

Purpose

Aid deep probablistic/statistical analysis of Farkle, including a web-based, multi-player implementation of Farkle for reference.

Quickstart

Want to get rolling and don’t have enough time to even read this sentence? Well, using Python 3, install the package with:

git clone https://bitbucket.org/carbonizer/thekraf &&
git -C thekraf checkout v0.1a12 &&
pip3 install -r thekraf/requirements.txt gunicorn ./thekraf

and run the app (using gunicorn as our production server) with:

eval "$(thekraf web gunicorn)"

Then browse to http://0.0.0.0:5000. Run the server more securely (prevent connections external to localhost) with:

eval "$(thekraf web --host 127.0.0.1 gunicorn)"

Then browse to http://127.0.0.1:5000.

Live Demo

This site is reset regularly and it may not be up, but you may find a demo running at http://tkdemo.penguinor.com.

Warning

The demo is running without SSL. Do not use any sensitive information on the site. Pretend as though someone is watching over your shoulder at all times.

TODOs

• support for multiple games at once
• add a buddy system so new games can only include confirmed buddies
• add option for reload on game change or reload user’s turn
• user customizable scoring (multiple preset configs already implemented)
• make shuffling players an option (shuffling is currently hard-coded to true)
• how the game ends (everyone getting one more chance)
• track game statistics
• cache certain test data so it doesn’t have to be generated each time tests are run

Indices and tables

• Index
• Module Index