Skip to content
DartanllaPublic

About

Open World Server system

Resources

Stars

417 stars

Watchers

37 watching

Forks

Latest commit

 

History

557 Commits

Folders and files

Repository files navigation

SabreDartStudios

Open World Server (OWS)

GitHub Workflow Status LICENSE Join Discord Unreal Engine Docker .Net

Open World Server (OWS) is a server instance manager designed to create large worlds in UE5. Either by stitching together multiple UE5 maps or by splitting a single large map into multiple zones, OWS will spin up and shut down server instances as needed based on your world population. OWS can load balance your world across multiple hardware devices. OWS can support thousands of players in the same world by instancing up and out. A single zone can be instanced multiple times to support a large population in one area. Areas of a map can also be split up into multiple zones to support a larger population. In addition to server instance management, OWS also handles persistence for Accounts, Characters, Abilities, Inventory and more.

Projects

Project Purpose
Benchmarks This project will allow us to configure and run performance testing on the OWS API. This will be important for comparing the impact of certain changes.
Character Persistence The Character Persistence API will be responsible for storing our player characters and all related data. This will be important for comparing the impact of certain changes.
Data This is a shared project that houses our data repository access code.
External Login Providers This project contains code for integrating with external login providers such as Xsolla, Google, Facebook, etc.
Instance Launcher This project builds our Instance Launcher that replaces the RPG World Server in OWS 1.
Instance Management This API manages Zone Instances and the OWS Instance Launchers.
Public API This API handles all API calls that come directly from player clients such as registration, login, and connecting to the game.
Shared This project houses various miscellaneous code that multiple other projects require.
Tests This project provides Unit testing and Functional testing and Benchmark Tools (Development)

Contributing

Documentation

Open World Server Documentation

Nilux external connection tickets

POST /api/Users/ExternalConnectionTicket accepts UserSessionGUID and a positive ServerId (the intended Edge server ID) in JSON over HTTPS. Include the same X-CustomerGUID header used for OWS login. The API checks that the session exists and has a selected character, then returns an opaque ticket, a new Base64-encoded 32-byte session secret, CharacterId, ServerId, and ExpiresAtUtc. The ticket expires after 45 seconds.

The default Docker Compose setup runs without the Nilux ticket integration. To enable it, copy src/.env to src/.env.tickets and add a unique OWSTicketValkeyPassword and a separate, randomly generated OWSTicketRedemptionApiKey. The copy is excluded from Git and Docker builds. Use a password without commas because it is passed in a comma-delimited Valkey connection string.

From src, add --env-file .env.tickets to the Compose command and append -f .docker/owsticket.yml after your usual Compose files, before up. For Visual Studio, set DockerComposeEnvFilePath to .env.tickets in docker-compose.dcproj and append ;.docker/owsticket.yml to AdditionalComposeFilePaths.

The optional owsticket service stores records in memory, publishes 127.0.0.1:6380, and configures the containerized Public API automatically. When running the Public API directly, configure OWSTicketConfig__ConnectionString with localhost:6380 and the Valkey password.

ITicketRepository exposes GetTicketAsync for retrieving the secret before handshake verification and RedeemTicketAsync for atomically claiming the ticket after the Edge verifies the AES-GCM authentication tag. A repeated claim by the same authenticated handshake succeeds until the original TTL expires; other claimants and other server IDs are rejected.

Nilux Edge accesses those operations through the private HTTPS endpoint POST /api/Users/RedeemExternalConnectionTicket; it never connects to Valkey. The endpoint accepts Claim: false for the pre-authentication lookup and Claim: true for the atomic claim, and requires X-Edge-Redemption-Key. The Compose override passes OWSTicketRedemptionApiKey to the API as OWS_TICKET_REDEMPTION_API_KEY. Set that API variable directly for a standalone API or Lambda deployment. Configure the same secret as NILUX_OWS_REDEMPTION_API_KEY on Edge. Keep the secret out of source control and the game client.

About

Open World Server system

Resources

Stars

417 stars

Watchers

37 watching

Forks

Releases

Packages

Used by

Contributors

Languages