update readme
This commit is contained in:
parent
fbb35714ac
commit
737c8c37ac
24
README.md
24
README.md
@ -4,3 +4,27 @@ A web version of Taiko no Tatsujin
|
|||||||
Running instance: https://taiko.bui.pm
|
Running instance: https://taiko.bui.pm
|
||||||
|
|
||||||
Still in developement. Works best with Chrome.
|
Still in developement. Works best with Chrome.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
**Requirements**: Python 2.7, [Flask](https://pypi.org/project/Flask/)
|
||||||
|
|
||||||
|
Create a SQLite databse named `taiko.db` with the following schema:
|
||||||
|
|
||||||
|
CREATE TABLE "songs" ( `id` INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT, `title` TEXT NOT NULL, `title_en` TEXT, `easy` INTEGER, `normal` INTEGER, `hard` INTEGER, `oni` INTEGER, `enabled` INTEGER NOT NULL, `category` INTEGER )
|
||||||
|
|
||||||
|
When inserting rows, leave any difficulty columns as NULL if you don't intend to add notecharts for them.
|
||||||
|
|
||||||
|
Each song's data is contained within a directory under `public/songs/`. For example:
|
||||||
|
|
||||||
|
└───public
|
||||||
|
├───songs
|
||||||
|
│ ├───1
|
||||||
|
│ │ bg.png
|
||||||
|
│ │ easy.osu
|
||||||
|
│ │ hard.osu
|
||||||
|
│ │ main.mp3
|
||||||
|
│ │ normal.osu
|
||||||
|
│ │ oni.osu
|
||||||
|
│ │
|
||||||
|
|
||||||
|
Run `app.py`, and use any web server to serve `public/` as the root directory, while routing `/api/` to the Flask server.
|
||||||
|
Loading…
Reference in New Issue
Block a user