The Web Service

The web service for the game is provided by txwerewolves.webservice.WebService. The service setup is similar to the basic setup for the terminal service. The service entry point is txwerewolves.webservice.WebService.startService(). A web site is created and a Twisted endpoint is constructed from string description of the host, port, and connection options. The endpoint is made to listen for incoming network events. It is configured to use the web site instance to create a protocol that will communicate with the web client.

The Web Site

The web site is created using the Klein micro-framework. While the web client allows anyone to log in with a self asserted username, it still uses the Twisted Cred system to “authenticate” players. Before constructing the web site, a txwerewolves.webauth.WebRealm is created. A portal is created and initialized with the realm. An instance of txwerewolves.webauth.WerewolfWebCredChecker is registered as the credential checker for the service.

An instance of txwerewolves.webservice.WebResources is created and will serve as a model for the resources in the web site. The root resources is obtained from this instance, and a twisted.web.server.Site is initialized with this root resource. The site will act as factory that creates protocol instances that interact with incoming HTTP requests.


HTTP requests are routed to resources in the web application. The resources have the following meanings:

  • /login - If the client browser has not established a session, it will be redirected to this resource. Here, a player may choose and submit a login name to establish a session.
  • /logout - A client that accesses this resource will have its session expired.
  • /static/ - Static resources like JavaScript, stylesheets, etc. are served from this resource tree.
  • /action - Clients can POST the action a player chooses to this resource to send commands to the application.
  • /settings - Clients can POST settings to this resource to change application settings and reset the application.
  • /chat - Clients can POST chat messages to this resource that will be displayed in community chat dialogs.
  • /werewolves - This resource serves the static HTML for the Werewolves! game.
  • /werewolves/… - There 6 distinct sub-resources a client can request: actions, phase-info, player-info, game-info, output, and request-all. Requesting one of these resources will trigger a corresponding update to be sent via a Server Sent Event (see the /subscribe resource, below).
  • /lobby - This resource serves the static HTML for the Lobby application.
  • /lobby/… - There are 2 sub-resources, status and actions. Requesting one of of these resources will trigger a corresponding update to be sent via a Server Sent Event (see the /subscribe resource, below).
  • /subscribe - Clients can request this resource to subscribe to server sent events from the application. These events are received by JavaScript handlers in the client browser that can update the user interface with new information or actions to be selected.

The Web Avatar

The web avatar is is created when a player browses to the /login resource of the web service. It triggers any existing avatar to shut itself down. The new avatar replaces the old avatar in the user database for the appropriate user entry. Any existing application will be converted to a similar application of the appropriate kind (e.g. a terminal Lobby application will be converted to a terminal web application).

Unlike the web avatar, the web avatar either handles its own requests or forwards them directly to the currently installed web application.

Rich Client Interface

Unlike, the terminal service client, the web client is meant to be a web browser. A web browser has a rich client interface, including its own embedded scripting engine. Javascript event handlers are included in the web pages to handle player input and to provide updates from the web service’s /subscribe resource. Contrast this with the terminal client, which provides a simple interface for producing character output at specific coordinates.