Welcome to SMServer’s documentation!

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

For Windows:

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 advanced option/configuration, type --help or see Advanced configuration

Source code

You can find the last version of the server on github

License

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

Indices and tables