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

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-1.3.0.tar.gz (306.6 kB view details)

Uploaded Source

Built Distribution

simpl_cloud-1.3.0-py3-none-any.whl (326.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simpl-cloud-1.3.0.tar.gz
  • Upload date:
  • Size: 306.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.11.4 pkginfo/1.7.0 requests/2.28.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.14

File hashes

Hashes for simpl-cloud-1.3.0.tar.gz
Algorithm Hash digest
SHA256 5daf785a61347987f54537b258fd22f2b47941f95b8eaf4be19ec759a1abb564
MD5 9654159838cc756eb1988c208198b15b
BLAKE2b-256 0838d65acfca3f1534fe72cfdb8f4eedb4dd5cfed04016061815c371d0d28e04

See more details on using hashes here.

File details

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

File metadata

  • Download URL: simpl_cloud-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 326.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.11.4 pkginfo/1.7.0 requests/2.28.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.14

File hashes

Hashes for simpl_cloud-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7d1e3ac8644d4f8551b0de9a876c2508e0501f221af0ae9ad6a424f53a136c7e
MD5 ca6b09bb91fa0f10ca5642b923c2a305
BLAKE2b-256 e1e62299566b9593d474c2b0befd511541c9cc570db02d197a5ff44bea5eb494

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