Skip to main content

Django app for qfusion authentication server

Project description

# django-warmama


## Overview

Django app for qfusion authentication server

## Installation

Install using `pip`, please use a virtualenv...

$ pip install django-warmama

## Basic Usage

An example project is provided and is sufficient for testing with QFusion.
Just get the server started.

cd example-project
python migrate
python createsuperuser
python runserver

To use it with QFusion, you need to add some User, Server and Player models; so
navigate over to the admin page at
[http://localhost:8000/admin/](http://localhost:8000/admin/) and create some.

1. Create some normal django users first, qf clients will use these username
password combinations to connect.
2. Create warmama Player models. The `login` field must be the username of a
previously created User.
3. Create warmama Server models. The `login` field here will be the server's
authtoken. Either `regip` or `regipv6` must be set to the server's ipaddress,
for local testing `` is allowed.

Finally configure the QFusion server and clients to use warmama for matchmaking.
For the server, set `sv_mm_enable` to `1` and `sv_mm_authtoken` to the `login`
value of the Server created above. For both the server and client set `mm_url`
to `` (without a trailing slash).

## Advanced Usage

Then configure your django project to use the app, you can override any of the
warmama settings (found in warmama/ in your project's

# project/


# project/
urlpatterns = [
url(r'^warmama/', include('warmama.urls', namespace='warmama', app_name='warmama')),

Finally, run the migrations and (optionally) load the fixtures

python migrate
python loaddata --app warmama gametypes
python loaddata --app warmama weapons

## Testing

Install testing requirements.

$ pip install -r requirements.txt

Run with runtests.

$ ./

You can also use the excellent [tox](
testing tool to run the tests against all supported versions of Python and
Django. Install tox globally, and then simply run:

$ tox

## Documentation

To build the documentation, you'll need to install `mkdocs`.

$ pip install mkdocs

To preview the documentation:

$ mkdocs serve
Running at:

To build the documentation:

$ mkdocs build


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-warmama-1.0.0.tar.gz (32.3 kB view hashes)

Uploaded source

Built Distribution

django_warmama-1.0.0-py2.py3-none-any.whl (55.6 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page