FlixelGDX Docs
Welcome to the FlixelGDX documentation. Whether you are picking up the framework for the first time or looking for a specific API, this is your starting point.
Where do I begin?
1. Generate your project
Head to the Getting Started page to create a ready-to-run Gradle project in seconds. Pick a language (Java or Kotlin), your platforms, an IDE, and a template — the page downloads a zip you can open straight away.
2. Build your first game
Work through Your First Project: Pong! — a beginner-friendly, step-by-step tutorial that walks you through building the classic Pong game while teaching nearly every important FlixelGDX concept along the way.
3. Learn the framework
Once you have a project running, read Core Concepts
for a quick tour of the essential building blocks every FlixelGDX game uses:
FlixelGame, FlixelState, sprites, groups, and more. Each section includes
side-by-side Java and Kotlin examples.
What else is in here?
| Page | What you will find |
|---|---|
| Compiling and Distributing | How to run, package, and ship a FlixelGDX game on desktop, web, and Android |
| Input | Raw input queries and action sets for platform-agnostic bindings |
| Physics and Collision | Arcade collision, overlap triggers, and FlixelObject velocity and drag |
| Debugger | In-game watches, the overlay stats panel, and the command console |
| Animations | Sparrow atlases, merging multiple sheets, Adobe Animate rigs, and the state machine |
| Cameras | Follow modes, zoom, screen effects, custom viewports, and split-screen |
| Sounds and Music | Sound effects, music streaming, volume control, and FlixelSound handles |
| Tweening | Animating numeric properties over time with easing, callbacks, and loops |
| Assets | Async loading, reference counting, custom loaders, and asset modes |
| Logging | Structured log messages, file output, listeners, and log modes |
| Videos | Framework extension to play video files directly in your game |
| Best Practices | Performance tips, memory management, and code-quality patterns |
| Troubleshooting | Solutions to the most common setup and runtime issues |
API Reference
The API Reference is a full, auto-generated Javadoc browser for every public class and method in the framework. Use it once you know what you are looking for and need the exact method signature or field list.