repsejnworb / OWS

Open World Server system

Open World Server (OWS)

By SabreDartStudios

Open World Server (OWS) is a server instance manager designed to create large worlds in UE4. Either by stitching together multiple UE4 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

• OWS 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.
• OWS Character Persistence - The Character Persistence API will be responsible for storing our player characters and all related data.
• OWS Data - This is a shared project that houses our data repository access code.
• OWS External Login Providers - This project contains code for integrating with external login providers such as Xsolla, Google, Facebook, etc.
• OWS Instance Launcher - This project builds our Instance Launcher that replaces the RPG World Server in OWS 1.
• OWS Instance Management - This API manages Zone Instances and the OWS Instance Launchers.
• OWS Public API - This API handles all API calls that come directly from player clients such as registration, login, and connecting to the game.
• OWS Shared - This project houses various miscellaneous code that multiple other projects require.

Additional Files Needed (not required for the Docker version of OWS)

• OWS 1 Web API: https://drive.google.com/file/d/1usSUaohEKJv1yPJKV2CVFuhyeocDt6Is/view?usp=sharing (this will be needed until we replace all of the OWS 1 functionality)
• OWS 1 MSSQL 2017 DB: https://drive.google.com/file/d/1pEXNK1fK5e4fLzSFARzdKvY7ESMkY9Ru/view?usp=sharing (this will be needed until we break out the DB into separate microservice respositories)

Contributing

• Coding Conventions
• Naming Guidelines
• Coding Style

Windows Server Setup Instructions (These instructions are not complete)

• Install Erlang (https://www.erlang.org/downloads) - must be a version your RabbitMQ version supports
• Install RabbitMQ (https://www.rabbitmq.com/install-windows.html)
• Enable the RabbitMQ Admin Web Console - rabbitmq-plugins enable rabbitmq_management
• Open the RabbitMQ Admin Web Console - http://localhost:15672/ - Login as guest / guest
• Create a new RabbitMQ User and give the user access to /
• Put those credentials in appsettings.json for the OWSInstanceLauncher
• Install IIS (from your Windows media)
• Install the .NET Core 3.1 Web Hosting Bundle - https://dotnet.microsoft.com/download/dotnet/3.1 - Windows Hosting Bundle link
• Create the folder in C:\inetpub\sites\OWSPublicAPI
• Create the folder in C:\inetpub\sites\OWSInstanceManagement

Docker Setup Instructions (Beta)

Requirements

• Download Or Clone OWS
• .Net Core 3.1 SDK
• .Net 5.0 SDK - Required For Mac & Linux
• SQL Server Management Studio

Windows

1. Download and Install Docker Desktop For Windows

2. Open OWS Project in Visual Studio 2019 Community

3. Select Docker Compose startup project and Launch Docker Compose.

   

4. (Optional) Running Docker Compose without Visual Studio Debugger, Enter the following Command Prompt from the OWS root directory.

   docker-compose -f docker-compose.yml -f docker-compose.override.windows.yml up -d
   

5. Open SQL Server Management Studio and connect to localhost with sa / yourStrong(!)Password

6. Run the following SQL statment against the Open World Server database. Be sure to replace the values CustomerName, FirstName, LastName, Email, and Password.

   EXEC [dbo].[AddNewCustomer] 'CustomerName', 'FirstName', 'LastName', 'Email', 'Password'
   

7. Run the following SQL statment against the Open World Server database to get your API key. Save this for later.

   SELECT TOP 1 CustomerGUID FROM Customers
   

8. Run the following SQL statment against the Open World Server database to add your local PC as a World Server. Replace [CustomerGUID] with the API key from the previous step.

   INSERT INTO WorldServers (CustomerGUID, ServerIP, MaxNumberOfInstances, ActiveStartTime, Port, ServerStatus, InternalServerIP, StartingMapInstancePort)
   VALUES ([CustomerGUID], '127.0.0.1', 10, NULL, '8081', 0, '127.0.0.1', '7778')
   

OSX

1. Download and Install Docker Desktop For Mac

2. Open OWS Project in Visual Studio For Mac

3. Run the following command in an terminal to install the Development Certificates

   dotnet dev-certs https --trust
   

4. Select Docker Compose startup project and Launch Docker Compose.

   

5. (Optional) Running Docker Compose without Visual Studio Debugger, Run the following command in an terminal from the OWS root directory.

   docker-compose -f docker-compose.yml -f docker-compose.override.osx.yml up -d
   

Linux

1. Download and Install Docker Engine For Linux
2. Close all Web Browsers
3. Download and Run dotnet-dev-certificate-linux to install Development HTTPS Certificate.
4. Run the following command in an terminal from the OWS root directory.

   sudo docker-compose -f docker-compose.yml -f docker-compose.override.linux.yml up -d