Skip to main content

Base models and API for Django-based simulations.

Project description

Base models and API for Django-based simulations.

Provides an API compatible with the Wharton Interactive marketplace.

Getting Started

Install simpl-cloud, with the API extras if required:

pip install simpl-cloud[api]

Add simpl to your project’s Django settings module, along with the following settings:

INSTALLED_APPS = {
    # ...
    'simpl',
}
SIMPL_GAME_EXPERIENCE = "simpl.GameExperience"
SIMPL_RUN = "simpl.Run"
SIMPL_INSTANCE = "simpl.Instance"
SIMPL_CHARACTER = "simpl.Character"
SIMPL_PLAYER = "simpl.Player"
SIMPL_LOGOUT_URL_NAME = "account_logout"

Add the following to your project’s URL conf:

urlpatterns = [
  # ...
  path("simpl/", include("simpl.urls")),
]

Architecture Overview

Run objects provide management and configuration of one or more game instances.

Launching game instances

When a player is added to a run, their details are stored in a Player object.

When they start playing your game, they will be attached to an Character object in a game Instance object that will track the progress of their game.

For multiplayer runs, these players will be initially grouped into Lobby object so they can be assigned to a game Instances. A lobby can be marked as ready once it is ready to start.

You can use Run.prepare to create new game Instance objects or manually create these.

Game play URL

The API uses a customizable url endpoint for players. You can specify this by using a custom Player model and overriding Player.get_play_url.

Alternatively, you can specify a SIMPL_GET_PLAY_URL in your settings as a dotted path to a function that receives a player instance and returns the correct url.

Run status

A run has the following statuses:

  • Set up (initial state, until any configuration options are provided)

  • Players prepare (optional step to if your game experience if players can interact with their Instance before gameplay starts)

  • Running (game Instances are running)

  • Debrief (optional step if your game experience provides a different interface after gameplay finishes)

Game Instance status

Each game Instance also has a status:

  • Preparing - waiting to start (Instance.date_start unset)

  • Playing - game in progress (Instance.date_start set but Instance.date_end unset)

  • Ended - game complete (Instance.date_end set)

Player status

Your app may mark a player as having completed the game (with a date).

Custom models

Extend the Simpl Django models by overriding the default classes in your project’s Django settings module:

  • Instance via SIMPL_INSTANCE = "your_app.YourInstance"

  • Character via SIMPL_CHARACTER = "your_app.YourCharacter"

  • GameExperience (only if your app provides multiple different game experiences) via SIMPL_GAME_EXPERIENCE = "your_app.YourGameExperience"

More rarely, you may also want to override the run and player:

  • Run via SIMPL_RUN = "your_app.YourRun"

  • Player via SIMPL_PLAYER = "your_app.YourPlayer"

Your overridden classes should subclass the related simpl.models.Base* abstract models.

The Character class will need two related abstract models, BaseCharacterData and BaseCharacterLinked. This is to make it possible to have character data as a template, not linked to a user or instance.

Auth0

If using Auth0 for social authentication, add the following Django settings to make sure users are correctly logged out of Auth0 and (optionally) redirected after logout:

ACCOUNT_ADAPTER = "simpl.auth0.Auth0LogoutAdapter"
AUTH0_LOGOUT_RETURN_TO = "some.url"

Project details


Release history Release notifications | RSS feed

This version

0.40

Download files

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

Source Distribution

simpl-cloud-0.40.tar.gz (151.1 kB view details)

Uploaded Source

Built Distribution

simpl_cloud-0.40-py3-none-any.whl (172.3 kB view details)

Uploaded Python 3

File details

Details for the file simpl-cloud-0.40.tar.gz.

File metadata

  • Download URL: simpl-cloud-0.40.tar.gz
  • Upload date:
  • Size: 151.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.0 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.10

File hashes

Hashes for simpl-cloud-0.40.tar.gz
Algorithm Hash digest
SHA256 9f4f41f689a4e66010cb45e8c1b6a39148a60fdc5ba099f2426de7999e742c17
MD5 619c99e87a3395e44ea69e1e8d2042ba
BLAKE2b-256 c065b2225de26f44134b374292ad795e808fd1a7cdde75ced8da67e2555db524

See more details on using hashes here.

File details

Details for the file simpl_cloud-0.40-py3-none-any.whl.

File metadata

  • Download URL: simpl_cloud-0.40-py3-none-any.whl
  • Upload date:
  • Size: 172.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.0 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.10

File hashes

Hashes for simpl_cloud-0.40-py3-none-any.whl
Algorithm Hash digest
SHA256 90bc2e9a36aec1513ca1c1ae8570d7dee385a8b07c813caded0898c0f5b20b26
MD5 a45e114f01464a0f4d3706bcb0279c56
BLAKE2b-256 a791e49b42748564332fde591461072716043725969ef8c61f3cefcddc1c7c78

See more details on using hashes here.

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