Module Hierarchy

• actor: Exports class Actor, all characters in the game are of class Actor.
• actorvisual: A Tkinter-based renderer for actors.
• animation: Exports Animation and AnimationPlayer used to display sprite-based animated characters in the game.
• bitmap: Exports storage class for bitmap images.
• datapath: Utility module, it stores location of the current game in gameroot variable.
• game: Defines Game class.
• gameui: Callable module that runs games and displays some Tkinter-based UI.
• movement: Exports class Movement that keeps track of Actor's position and calculates a desired transition for the next frame.
• osm: OSM package separates the core of the AI engine from the rest of the code.
  • agent: The module defines two fundamental classes: Agent (FSM with messasging) and ScriptableAgent (an Agent extandable with scripts).
  • collective: Exports Dispatcher and Collective, the fundamental container classes for group behavior in the game.
  • fsm: Defines Finite State Machine (FSM), an object with distinct states and update functions for each state (actions).
  • message: Defines generic class Message used for both commands and reports.
  • script: Exports Script class, a base for xmlScript, used by ScriptableAgent.
• xmlanimloader: An utility module for loading animation from animlist xml files.
• xmlscript: Exports xmlScript class used by ScriptableAgent.
• xmlutils: A bunch of handy utility functions for dealing with xml files.

Class Hierarchy

• bitmap.Bitmap: Bitmap stores Tkinter id for the image displayable on Tkinter canvas.
  • actorvisual.ActorVisual: Renders actors by showing images on the Tkiner canvas object.
• gameui.GameUI: UI for the game object.
• osm.fsm.FSM: A simple FSM (Finite State Machine), a base class for most objects in the game.
  • osm.agent.Agent: Agent is an FSM with message handling capabilities.
    • actorvisual.ActorVisual: Renders actors by showing images on the Tkiner canvas object.
    • animation.Animation: Plays animation by displaying images from a list of N frames.
    • animation.AnimationPlayer: Keeps a list of animations and can play them by name.
    • movement.Movement: A movement calculator class.
    • osm.agent.ScriptableAgent: Extends hardcoded set of message handlers and actions with scripted ones, defined in script.
      • osm.collective.Dispatcher: Dispatcher is a ScriptabelAgent (FSM with messaging) that sends commands to the reporting Agents, listens to the input messages (reports) from its members and can run a script on itself.
        • osm.collective.Collective: Collective is a Dispatcher that owns its members, other agents.
          • actor.Actor: A class for characters in the game.
          • game.Game: A top level collective object, it represents the game itself.
• osm.message.Message: A class for generic timed message.
• osm.script.Script: Script keeps and can execute string presentation of methods (scripted event handlers and actions).
  • xmlscript.xmlScript: Can load individual methods from .py files after reading master xml file with the list of all methods and names of inherited scripts.