Welcome to Fretsboard’s documentation!

Fretsboard is a web scoreboard for the rhythm game Frets On Fire (and its forks).

Introduction

Presentation

Fretsboard is a web scoreboard for the rhythm game Frets On Fire (and similar).

Origin

This application comes from the old Frets On Fire Charts Server.

Other scoreboard were developped, in PHP:

For more information, see the Frets On Fire forum post.

Features

The original scoreboard provides:

  • the list of users
  • the list of songs
  • scores per users
  • top scores
  • a searching toolbar for users and songs
  • an uploading entry for scores

In addition, this scoreboard provides:

  • translations
  • a minimal design

Other features are planned for the next version.

User guide

World instance

There is a stable instance, which aims to regroup all scores.

Upload a score

To upload a score, in your rhythme game configuration file, you should modify the uploadurl parameter (or similar) to redirect to [instance]/upload.

Installation

Settings (optional)

Before running this application, you should configure some local settings:

  • SECRET_KEY: you need to generate a new one
  • DEBUG: default is True, which is not secured
  • ALLOWED_HOSTS: the host you will use
  • DATABASES: the database you will use (default is an SQLite one)
  • PIWIK_URL: the URL of your Matomo instance
  • PIWIK_SITE_ID: the id of your scoreboard instance

Run it locally

On a virtualenv:

git clone git@github.com:Linkid/fretsboard.git
cd fretsboard
pip install -r requirements.txt
./manage.py migrate
./manage.py runserver

Run it on Heroku

Database used here: PostgreSQL In your console:

heroku login

heroku apps:create your-scoreboard
heroku addons:create heroku-postgresql --app your-scoreboard

git remote set-url heroku git@heroku.com:your-scoreboard.git
git push heroku master

heroku ps:scale web=1
heroku config:set SECRET_KEY=`openssl rand -base64 32`
heroku run python manage.py migrate
heroku open