UPBGE Manual

Welcome to UPBGE’s Documentation! Here you will find definitions of the available tools and features in UPBGE, step-by-step tutorials to certain tasks and the Python API for game logic programming with detailed information (and examples in some cases).

Visit the UPBGE’s website or contribute to this manual.

Also, if you want to read the whole manual offline you can download from this link.

Manual

• Introduction
  • Briefing
  • A Deeper Look
  • Compatibility Notes
• Tutorials
  • Getting Started
  • Introducing Python
• Editors
  • Properties Editor
  • Logic Editor
• Datablocks
  • Armature
  • Camera
  • Empty
  • Group
  • Lamp
  • Mesh
  • Object
  • Text
  • Image
  • Library
  • Sound
  • Action
  • Material
  • Scene
  • Texture
  • World
• Logic
  • Introduction
  • Sensors
  • Controllers
  • Actuators
  • Properties
  • States
• Release
  • Licensing of Games
  • Performance Considerations
  • Standalone Player
  • Release Procedure
• About
  • Introduction to the UPBGE Manual
  • License
  • What’s New

API Reference

• Game Engine Modules (bge)
  • Game Types (bge.types)
  • Game Logic (bge.logic)
  • Rasterizer (bge.render)
  • Video Texture (bge.texture)
  • Game Keys (bge.events)
  • Physics Constraints (bge.constraints)
  • Application Data (bge.app)
• Audio System (aud)
  • Basic Sound Playback
  • Functions
  • Device
  • Factory
  • Handle
  • Constants
• Math Types & Utilities (mathutils)
  • BVHTree Utilities (mathutils.bvhtree)
  • Geometry Utilities (mathutils.geometry)
  • Interpolation Utilities (mathutils.interpolate)
  • KDTree Utilities (mathutils.kdtree)
  • Noise Utilities (mathutils.noise)
  • Color
  • Euler
  • Matrix
  • Quaternion
  • Vector
• OpenGL Wrapper (bgl)
• Font Drawing (blf)
  • Text Example
  • Functions
  • Constants
• GPU functions (gpu)
  • GPU Off-Screen Buffer (gpu.offscreen)
  • Intro
  • Constants
  • Functions
  • Notes