- Quick Start Guide - Build your first application state (30 minutes)
- Cheat Sheet - One-page syntax reference
- Glossary - GPF terminology reference
- Why GPF? - Decision guide
GPF is built around four core components that work together to eliminate backend infrastructure code.
Application State - Server-authoritative constructs that manage your game state. You define fields and message handlers; GPF handles persistence, networking, and scaling.
DataStore - A global data store where all renderable data resides on the client. GPF automatically synchronizes the DataStore with the world state determined on the server.
ViewBindings - Reusable UI components that subscribe to and draw data from the DataStore. When application state changes, ViewBindings auto-update the UI.
Test Framework - A framework for developing and testing your application. The fully simulated backend lets you run the entire server inside Unity for rapid iteration, which is helpful when you're debugging game logic without deploying to the cloud.
See Architectural Patterns for detailed patterns and best practices.
Essential guides for building with GPF:
- Architectural Patterns - PlayerSO, View, Singleton patterns
- Security Guide - Validate input, prevent vulnerabilities
- Testing Guide - Simulated backend, unit tests, integration tests
- Authentication Guide - OAuth integration, session management
- DataStore Sync - How data synchronization works
- Development Workflow - Feature development process
- Scheduling Guide - Delayed messages, recurring tasks
- Production Readiness - Production checklist
- External Integrations - Third-party services
Complete API and technical references:
- API Reference - Complete API documentation
- Attribute Reference - All GPF attributes explained
- Testing API Reference - Testing framework API
- ServerObject Guide - Application state fundamentals
- Major Components - Component overview
Deep dives into advanced features:
- Advanced Patterns - Complex scenarios, optimizations
- ViewBindings - Complete ViewBindings documentation
- Understanding Props - Props system deep dive
- Provided ViewBindings - Built-in bindings
- Building Custom ViewBindings - Create your own
Deployment and infrastructure guides:
- Deployment Guide - AWS deployment walkthrough
- AWS Setup Guide - Detailed AWS configuration
- Deploy Configurations - Configuration reference
- AWS Permissions - IAM policy JSON
Step-by-step walkthroughs:
- Tutorials Index - Complete tutorial overview
- Coin Flipper Walkthrough - Single-player + leaderboard
- Rock Paper Scissors Walkthrough - Multiplayer matchmaking
Community resources:
- Contact & Support - Discord, email, GitHub
- Downloads - Download packages and examples
- Feature Tasking Guide - Task breakdown strategies
If you're new to GPF, here are some suggested learning paths depending on your goals.
Start here if you're completely new to GPF. The Quick Start Guide takes about 30 minutes and walks you through building your first application. After that, the Coin Flipper tutorial shows you a complete working example. Once you've built something yourself, the Architectural Patterns guide will help you understand when to use different design patterns.
If you already understand application state and want to focus on connecting your UI to server state, start with the ViewBindings guide. The Props system is key to understanding how data flows from your state to UI components. The DataStore Sync guide explains the underlying synchronization mechanism.
If you're ready to deploy a production game, start with the Security Guide to validate your input handling. The Deployment Guide walks you through deployment setup. The Production Readiness checklist helps you verify everything is ready.
| I want to... | Guide |
|---|---|
| Get started with GPF | Quick Start |
| Understand core patterns | Architectural Patterns |
| Connect UI to data | ViewBindings |
| Secure my game | Security Guide |
| Deploy to AWS | Deployment Guide |
| See all APIs | API Reference |