Skip to content

Moutix/stepmania-server

Repository files navigation

Stepmania Server

docs Documentation Status
tests
Travis-CI Build Status AppVeyor Build Status Coverage
package PyPI Package latest release Supported versions License

SMServer is an implementation of a stepmania server in python3.

The goal is to provide a simple server implementation which can easily be adapt to your need.

Requirement

SMServer only support python3.3 and higher. It use:

  • PYYaml
  • SQLAlchemy
  • asyncio

Installation

Install the server using pip, or directly from source:

$ python3 setup.py install

or

$ pip install smserver

Configuration

The server will come with a default configuration file located in:

$ /etc/smserver/conf.yml

By default, the server will use a sqlite database. To change it adapt the database section of the configuration file.

EG for mysql:

database:
    type: "mysql"
    user: "stepmania"
    password: "*******"
    database: "stepmania"
    host: "localhost"
    port:
    driver: "pymysql"

To launch the server just type:

$ smserver

For more information check the docs

License

This software is licensed under the MIT License. See the LICENSE file in the top distribution directory for the full license text.