Gale

Getting started

  • Installation
    • Requirements
    • From source
    • Starting a new project

Guides

  • gale.ai
    • Steering only
    • Behavior tree
    • Decision tree
    • Blackboard
    • Using it with Factory
    • Graphs
    • Search algorithms
  • gale.animation
    • Switching between named animations
  • gale.camera
    • Basic usage
    • Following a target
    • Zoom
    • Keeping the camera inside the map
    • Screen shake
    • Screen ↔ world coordinates
    • Known limitations
  • gale.ecs
    • World, entities, and components
    • Querying entities
    • Systems
  • gale.factory
  • gale.frames
  • gale.input_handler
    • Typical project setup
    • Registering a listener manually
    • Key combos
    • Gamepads
  • gale.log
    • Basic usage
    • Adding another destination (Graylog and friends)
    • Named loggers
  • gale.net
    • Basic connection and messaging
    • Choosing a channel
    • Round-trip time
    • LAN discovery
    • Dedicated server vs. player-hosted
    • Host migration
    • Room codes
    • Client-side prediction and server reconciliation
    • Entity interpolation and lag compensation
    • Security notes
  • gale.particle_system
  • gale.physics
    • Creating a world and bodies
    • Stepping the simulation: update vs. fixed_update
    • Reading and driving a body
    • Collision: callbacks vs. touching_bodies
    • Joints
    • Scene graph
    • Debug rendering
  • Project template (gale-admin)
    • Adding a state (gale-admin create-state)
  • gale.state
    • StateMachine
    • HierarchicalState
    • StateStack
  • gale.stencil
    • Fog of war / vision reveal
    • Cropping to a shape
    • How it works
  • gale.text
  • gale.tilemap
    • Building a TileMap by hand
    • Loading a map made in Tiled
    • Collision: solid walls and one-way platforms
    • Isometric maps
    • Known limitations
  • gale.timer
  • gale.ui
    • A simple menu
    • Widget list
    • Mouse support
    • Customizing look and feel
    • Cursors from settings.py
    • Paginated text: click-through or buttons
    • Closable windows
    • Known limitations
  • gale.sequence
    • Step
    • StepGroup
    • Sequence
  • gale.quest
  • gale.cutscene
    • Running several beats at once
    • “Playing a video”
    • Writing your own beats

API reference

  • gale package
    • Subpackages
      • gale.ai package
      • gale.cutscene package
      • gale.ecs package
      • gale.log package
      • gale.management package
      • gale.net package
      • gale.physics package
      • gale.tilemap package
      • gale.ui package
    • Submodules
      • gale.animation module
      • gale.camera module
      • gale.ease_functions module
      • gale.factory module
      • gale.frames module
      • gale.game module
      • gale.input_handler module
      • gale.math_util module
      • gale.particle_system module
      • gale.quest module
      • gale.sequence module
      • gale.state module
      • gale.stencil module
      • gale.text module
      • gale.timer module
Gale
  • Overview: module code

All modules for which code is available

  • gale.ai.agent
  • gale.ai.behavior_tree
  • gale.ai.blackboard
  • gale.ai.decision_tree
  • gale.ai.graph
  • gale.ai.minimax
  • gale.ai.perception
  • gale.ai.search
  • gale.ai.steering
  • gale.animation
  • gale.camera
  • gale.cutscene.actions
  • gale.cutscene.cutscene
  • gale.ease_functions
  • gale.ecs.system
  • gale.ecs.world
  • gale.factory
  • gale.frames
  • gale.game
  • gale.input_handler
  • gale.log.config
  • gale.log.discord_webhook_handler
  • gale.log.graylog_handler
  • gale.log.level
  • gale.log.sentry_handler
  • gale.management
    • gale.management.gale_admin
  • gale.math_util
  • gale.net.channel
  • gale.net.client
  • gale.net.discovery
  • gale.net.interpolation
  • gale.net.peer
  • gale.net.prediction
  • gale.net.protocol
  • gale.net.room_code
  • gale.net.serialization
  • gale.net.server
  • gale.particle_system
  • gale.physics.body
  • gale.physics.body_type
  • gale.physics.joint
  • gale.physics.node
  • gale.physics.shapes
  • gale.physics.world
  • gale.quest
  • gale.sequence
  • gale.state
  • gale.stencil
  • gale.text
  • gale.tilemap.collision
  • gale.tilemap.isometric
  • gale.tilemap.tiled_loader
  • gale.tilemap.tilemap
  • gale.timer
  • gale.ui.button
  • gale.ui.checkbox
  • gale.ui.container
  • gale.ui.cursor
  • gale.ui.label
  • gale.ui.list_view
  • gale.ui.manager
  • gale.ui.panel
  • gale.ui.progress_bar
  • gale.ui.text_box
  • gale.ui.text_input
  • gale.ui.theme
  • gale.ui.widget
  • gale.ui.window

© Copyright 2021-2026, Alejandro Mujica.

Built with Sphinx using a theme provided by Read the Docs.