Welcome to the Super Tux War documentation! This is a comprehensive guide for developers, level designers, and contributors.
Complete guide to creating and designing levels for Super Tux War.
- Getting Started - Create your first level
- Tile Layers & Block Types - Understanding the tile system
- Spawn Points - Character spawning system
- Level Thumbnails - Automatic thumbnail generation
- Navigation Graph - AI pathfinding system
How to contribute code, assets, documentation, and more. Includes list of needed assets.
Feature roadmap and development priorities (multiplayer, sound system, game modes, etc.).
Component-based character architecture for players and NPCs.
- Character System Overview - Architecture and components
- Character Controller - Main controller coordination
- Physics Component - Movement, jumping, gravity
- Lifecycle Component - Death, respawn, spawn protection
- Acceleration Physics - SMW-style momentum-based movement system
- Debug Launch Config - Local-only scene + debug overrides
- Event Bus (coming soon) - Event system architecture
- Game State (coming soon) - State management
- Input Management (coming soon) - Input handling
- Main README - Project overview and game design
- Play in Browser
- Godot 4.5.1 Documentation
This documentation is maintained alongside the code in the docs/ folder. When making code changes, please update the relevant documentation to keep everything in sync.
- Use clear, concise language
- Include code examples where relevant
- Add screenshots/diagrams when helpful
- Keep file paths relative to project root
- Follow markdown best practices
super-tux-wars/
├── assets/ # Sprites, tiles, audio
├── scenes/ # Scene files (.tscn)
├── scripts/ # GDScript code
│ ├── characters/ # Player & NPC logic
│ ├── core/ # Core systems
│ ├── levels/ # Level management
│ ├── objects/ # Interactive objects
│ └── ui/ # User interface
├── addons/ # Editor plugins
└── docs/ # This documentation
The game uses 32×32 pixel tiles and SMW-style acceleration physics defined in GameConstants:
- Tile Size: 32px
- Acceleration: 30 px/s² (7.5 px/s² on ice)
- Friction: 12 px/s² ground, 3.6 px/s² ice/air
- Gravity: 1440 px/s²
- Jump Velocity: -540 px/s
- Max Walk Speed: 240 px/s
- Max Run Speed: 330 px/s (turbo)
See game_constants.gd for complete values and Acceleration Physics for detailed behavior.
Found a mistake or want to improve the docs? Contributions are welcome!
- Edit markdown files in the
docs/folder - Test that links work correctly
- Submit a PR with your changes
Version: Godot 4.5.1
Last Updated: 2025-11-09