Tutorials¶

Welcome to the Brine2D tutorials! These hands-on guides will take you from basic concepts to building complete game systems. Each tutorial includes working code examples and explains the "why" behind each step.

🎯 Learning Path¶

We recommend following these tutorials in order, but feel free to jump to topics that interest you most.

graph LR
    A["Moving Sprites"] --> B["Animation System"]
    B --> C["Collision Detection"]
    C --> D["Platformer"]
    C --> E["Top-Down Adventure"]

    style A fill:#4ec9b0,color:#000
    style B fill:#569cd6,color:#fff
    style C fill:#ce9178,color:#000
    style D fill:#dcdcaa,color:#000
    style E fill:#dcdcaa,color:#000

📚 Available Tutorials¶

Moving Sprites ¶

Difficulty: Beginner | Time: 15 minutes

Learn the fundamentals of sprite rendering in Brine2D. You'll load textures, draw sprites, and create smooth movement with delta time.

What you'll learn: - Loading textures with ITextureLoader - Drawing sprites at screen positions - Handling keyboard input for movement - Using delta time for frame-rate independent motion - Working with Vector2 for positions

Prerequisites: Completed Quick Start

Animation System ¶

Difficulty: Beginner | Time: 20 minutes

Master Brine2D's sprite animation system. Create walking, running, and action animations from sprite sheets.

What you'll learn: - Loading sprite sheets - Creating AnimationClip objects - Using SpriteAnimator to play animations - Switching between animations (walk, run, jump) - Controlling animation speed and looping

Prerequisites: Moving Sprites

Key Concepts: - Sprite sheets and frame extraction - Animation clips with multiple frames - Frame duration and timing - Looping vs one-shot animations

Collision Detection ¶

Difficulty: Intermediate | Time: 30 minutes

Implement collision detection and response using Brine2D's collision system. Build interactive objects and solid walls.

What you'll learn: - Understanding CollisionSystem - Creating BoxCollider and CircleCollider shapes - Detecting collisions between objects - Implementing collision response (blocking, sliding) - Building a coin collection system

Prerequisites: Animation System

Key Concepts: - Collision shapes (boxes and circles) - Collision detection algorithms - Separation and penetration - Trigger vs solid collisions

Building a Platformer ¶

Difficulty: Intermediate | Time: 45 minutes

Create a complete 2D platformer with jumping, gravity, and platform collision. This tutorial combines everything you've learned.

What you'll learn: - Implementing gravity and jumping - Platform collision (top-only platforms) - Tilemap loading with Tiled - Camera following the player - Parallax scrolling backgrounds - Game state management (lives, score)

Prerequisites: Collision Detection

Covers: - Physics simulation (gravity, velocity, acceleration) - Tilemap rendering and collision - Camera systems with Camera2D - Scene management for multiple levels

Top-Down Adventure ¶

Difficulty: Intermediate | Time: 45 minutes

Build a top-down adventure game with 8-directional movement, NPCs, and dialogue. Perfect for RPG-style games.

What you'll learn: - 8-directional movement and animation - NPC interaction system - Dialogue boxes with text rendering - Inventory management - Tilemap-based world design - Trigger zones and events

Prerequisites: Collision Detection

Covers: - Grid-based movement - State machines for NPCs - UI system for dialogue - Event-driven interactions

🔧 Tutorial Code¶

All tutorial code is available in the samples/BasicGame directory:

AnimationDemoScene.cs - Animation system demo
CameraDemoScene.cs - Camera following and zoom
CollisionDemoScene.cs - Collision detection and UI

You can run these demos to see the final results before starting each tutorial.

💡 Tips for Learning¶

1. Run the Code First¶

Before reading each tutorial, run the demo scene to see what you're building. Understanding the end goal helps you learn faster.

2. Experiment and Break Things¶

After completing a tutorial, modify the code: - Change animation speeds - Add more collision objects - Adjust physics parameters

Breaking things teaches you how they work!

3. Use the Logger¶

Brine2D uses ILogger<T> for debugging. Add log messages to understand execution flow:

Logger.LogInformation("Player collided with {Object}", collision.Name);

4. Read the API Docs¶

Each tutorial references API documentation. Open them side-by-side: - Core API - Rendering API - Input API

5. Ask Questions¶

Stuck? Check out: - Common Issues - GitHub Discussions - Discord Community (coming soon)

🎓 After the Tutorials¶

Once you've completed these tutorials, you'll be ready to:

Build Your Own Game - You have all the tools!
Explore Advanced Guides - Check out Guides for deeper topics
Study the Samples - See Samples for complete game examples
Contribute - Help improve Brine2D! See Contributing

📦 What's Included in Each Tutorial¶

Every tutorial follows the same structure:

Section	Description
Overview	What you'll build and why it matters
Prerequisites	What you need to know first
Setup	Project setup and dependencies
Step-by-Step	Guided implementation with explanations
Complete Code	Full working example
Challenges	Exercises to extend what you learned
Next Steps	Where to go from here

🚀 Ready to Start?¶

Jump into Moving Sprites to begin your Brine2D journey, or pick any tutorial that interests you!

Happy game dev! 🎮