{"id":38051476,"url":"https://github.com/beyond-immersion/bannou-service","last_synced_at":"2026-02-24T03:18:16.856Z","repository":{"id":332213282,"uuid":"602465530","full_name":"beyond-immersion/bannou-service","owner":"beyond-immersion","description":"The all-purpose .NET monoservice for the Beyond Immersion game servers.","archived":false,"fork":false,"pushed_at":"2026-01-26T08:00:09.000Z","size":17067,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-26T20:59:08.163Z","etag":null,"topics":["cloud-services","csharp","docker","dotnet","game-backend","game-development","game-server","game-services","gamedev","goap","goap-planner","matchmaking","microservices","multiplayer","npc-ai","nswag","openapi","openresty","realtime","websocket"],"latest_commit_sha":null,"homepage":"https://beyond-immersion.com","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beyond-immersion.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":["DonLoquacious"]}},"created_at":"2023-02-16T09:13:54.000Z","updated_at":"2026-01-22T00:01:59.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/beyond-immersion/bannou-service","commit_stats":null,"previous_names":["beyond-immersion/bannou-service"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/beyond-immersion/bannou-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyond-immersion%2Fbannou-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyond-immersion%2Fbannou-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyond-immersion%2Fbannou-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyond-immersion%2Fbannou-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beyond-immersion","download_url":"https://codeload.github.com/beyond-immersion/bannou-service/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyond-immersion%2Fbannou-service/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28881381,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T16:41:59.663Z","status":"ssl_error","status_checked_at":"2026-01-29T16:39:39.641Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud-services","csharp","docker","dotnet","game-backend","game-development","game-server","game-services","gamedev","goap","goap-planner","matchmaking","microservices","multiplayer","npc-ai","nswag","openapi","openresty","realtime","websocket"],"created_at":"2026-01-16T20:07:38.004Z","updated_at":"2026-02-24T03:18:16.839Z","avatar_url":"https://github.com/beyond-immersion.png","language":"C#","funding_links":["https://github.com/sponsors/DonLoquacious"],"categories":[],"sub_categories":[],"readme":"# Bannou Service\n\n[![Build Status](https://github.com/beyond-immersion/bannou-service/actions/workflows/ci.unit.yml/badge.svg?branch=master\u0026event=push)](https://github.com/beyond-immersion/bannou-service/actions/workflows/ci.unit.yml)\n\nBannou is a schema-driven monoservice platform for multiplayer games. It provides a WebSocket-first edge gateway with zero-copy message routing, plugin-based service architecture, and abstracted infrastructure (lib-state, lib-messaging, lib-mesh). Designed to support Arcadia, a revolutionary MMORPG with 100,000+ AI-driven NPCs, Bannou scales from a single development machine to distributed production clusters without code changes.\n\n## Quick Start\n\n```bash\n# 1. Clone\ngit clone https://github.com/beyond-immersion/bannou-service.git\ncd bannou-service\n\n# 2. Install dev tools (.NET 10, NSwag, Python, Node.js)\n./scripts/install-dev-tools.sh\nsource ~/.bashrc\n\n# 3. Build and verify\nmake quick\n\n# 4. Start the stack\nmake up-compose\n\n# 5. Verify it's running\ncurl http://localhost:8080/health\n```\n\n**Next steps:** See the [Quickstart Guide](docs/guides/QUICKSTART.md) for client/service integration, or the [Getting Started Guide](docs/guides/GETTING-STARTED.md) for a comprehensive walkthrough.\n\n## Documentation\n\n### Getting Started\n\n| I want to... | Time | Guide |\n|--------------|------|-------|\n| **Get running quickly** | 5 min | [Quickstart](docs/guides/QUICKSTART.md) |\n| **Full setup walkthrough** | 30 min | [Getting Started](docs/guides/GETTING-STARTED.md) |\n| **Connect a game client** | 15 min | [Client Integration](docs/guides/CLIENT-INTEGRATION.md) |\n| **Make service-to-service calls** | 10 min | [SDKs Overview](docs/guides/SDK-OVERVIEW.md) |\n\n### Development\n\n| I want to... | Read... |\n|--------------|---------|\n| Understand the architecture | [Bannou Design](docs/BANNOU-DESIGN.md) |\n| Add or extend a plugin | [Plugin Development Guide](docs/guides/PLUGIN-DEVELOPMENT.md) |\n| Understand a specific service | [Plugin Deep-Dives](docs/plugins/) (41 services) |\n| Run and write tests | [Testing Guide](docs/operations/TESTING.md) |\n| Contribute code | [Development Rules](docs/reference/TENETS.md) |\n\n### Operations\n\n| I want to... | Read... |\n|--------------|---------|\n| Deploy to production | [Deployment Guide](docs/guides/DEPLOYMENT.md) |\n| Understand CI/CD pipelines | [GitHub Actions](docs/operations/GITHUB-ACTIONS.md) |\n| Set up NuGet publishing | [NuGet Setup](docs/operations/NUGET-SETUP.md) |\n\n## Key Features\n\n- **WebSocket-First**: Connect service edge gateway with 31-byte binary headers for zero-copy routing\n- **Schema-Driven**: OpenAPI specs generate controllers, models, clients, and tests—you write only 18-35% of the code\n- **Plugin Architecture**: Each service is an independent assembly, loadable via environment config\n- **Infrastructure Abstraction**: Portable infrastructure (databases, messaging, service mesh) via lib-state, lib-messaging, and lib-mesh\n- **Monoservice Flexibility**: Same binary deploys as monolith or distributed microservices\n\n## Essential Commands\n\n```bash\n# Development\nmake build                 # Build all projects\nmake generate              # Regenerate services from schemas\nmake format                # Fix formatting and line endings\n\n# Testing\nmake test                  # All unit tests\nmake test-http             # HTTP integration tests\nmake test-edge             # WebSocket edge tests\nmake test-ci               # Full CI pipeline locally\n\n# Docker\nmake up-compose            # Start local stack\nmake down-compose          # Stop and cleanup\n```\n\n## Technical Specifications\n\n- [WebSocket Protocol](docs/WEBSOCKET-PROTOCOL.md) - Binary protocol specification\n- [Schema Rules](docs/reference/SCHEMA-RULES.md) - OpenAPI schema authoring reference\n- [Permissions System](docs/X-PERMISSIONS-SPECIFICATION.md) - Role-based access control schema\n- [Service Details](docs/GENERATED-SERVICE-DETAILS.md) - Service descriptions and API endpoints\n- [Events Reference](docs/GENERATED-EVENTS.md) - Auto-generated event documentation\n- [Configuration Reference](docs/GENERATED-CONFIGURATION.md) - Environment variables\n- [State Stores](docs/GENERATED-STATE-STORES.md) - Redis/MySQL state stores\n\n## Project Structure\n\n```\nbannou-service/\n├── schemas/              # OpenAPI specifications (source of truth)\n├── plugins/lib-*/        # Service plugins (41 services)\n├── bannou-service/       # Main application and shared code\n├── sdks/                 # SDK packages (C#, TypeScript, Unreal)\n│   ├── core/             # Shared types (BannouJson, ApiException, base events)\n│   ├── server/           # Server SDK (mesh clients, behavior runtime)\n│   ├── client/           # Client SDK (WebSocket, typed proxies, events)\n│   ├── client-voice/     # Voice communication SDK\n│   ├── bundle-format/    # .bannou archive format (LZ4 compression)\n│   ├── asset-*/          # Asset loading/bundling (client, server, Stride, Godot)\n│   ├── scene-composer-*/ # Scene composition (core, Stride, Godot)\n│   ├── music-*/          # Music generation (theory, storyteller)\n│   ├── typescript/       # TypeScript client SDK\n│   └── unreal/           # Unreal Engine integration\n├── tools/                # Testing and inspection tools\n│   ├── http-tester/      # HTTP integration test framework\n│   ├── edge-tester/      # WebSocket edge test framework\n│   └── bannou-inspect/   # Assembly inspection CLI\n├── examples/             # Example projects and demos\n├── docs/                 # Documentation\n├── provisioning/         # Docker and deployment configs\n└── scripts/              # Code generation and build scripts\n```\n\n## Community\n\n- **Discord**: [Beyond Immersion](https://discord.gg/3eAGYwF3rE) - Discussion, questions, and collaboration\n- **GitHub Issues**: Bug reports and feature requests\n- **GitHub Discussions**: Questions and broader conversations\n\n## Contributing\n\nWe welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\nPlease note that this project follows a [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeyond-immersion%2Fbannou-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeyond-immersion%2Fbannou-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeyond-immersion%2Fbannou-service/lists"}