]
08-01-2023, 03:44 PM
How do I get it set up?
Generating Events
The script uses generated RAGE events (network & UI) via JSON manifest files. These files are located in \EventDescriptors\Network\ and \EventDescriptors\UI\
Any time you add or modify an event, you must run the GenerateEvents.bat file.
Adding New Scripts & Resources
All content in OwlV is cooked into archive files which are validated during cooker time, and loaded by the server. This cook/validation step helps avoid runtime issues and makes deployment easier.
Anytime you add, remove or modify (the file name, not contents), you must update the associated JSON descriptor in \Descriptors\
Files are defined by providing their filename, and type (e.g. ClientScript, ServerScript, etc) - please refer to existing descriptors for reference.
Using the Cooker
By default, the cooker uses symbolic links to allow for fast / near-instant iteration times. In 'Debug Full Cook' and 'Release' targets, a full cook, including code analysis, archive and unarchive are performed.
OwlV requires Windows Developer Mode to be enabled. This can be enabled by going to Start -> Developer Mode -> and checking the first checkbox.
Build Configurations
Debug x64 - Recommended for development, also enables 'fast iteration mode' for faster dev times
Debug Full Cook x64 - Simulates a release style cook, but uses debug binaries. Only recommended for diagnosing cook issues
Release x64 - Recommended for your server build
For running in debugger, you should start the Boot project as your startup project.
What variables should be I be changing?
You can search the code base for "TODO_GITHUB" for variables which you will want to update.
Please also refer to the environment variables below, which are required.
Database Configuration
The database connections must be configured before running the server. Set the following environment variables:
GAME_DATABASE_IP
GAME_DATABASE_NAME
GAME_DATABASE_USERNAME
GAME_DATABASE_PASSWORD
GAME_DATABASE_PORT
AUTH_DATABASE_IP
AUTH_DATABASE_NAME
AUTH_DATABASE_USERNAME
AUTH_DATABASE_PASSWORD
AUTH_DATABASE_PORT
Web Server Configuration
The game server runs a web server for remote UCP calls. The user is always ucp. Calling URL is
HTTP_SERVER_BIND_IP
HTTP_SERVER_PASS
HTTP_SERVER_WHITELIST The IP that will be making calls
Configuration
The following environment variables can be used to tweak settings:
Required
GAME_DATABASE_IP
GAME_DATABASE_NAME
GAME_DATABASE_USERNAME
GAME_DATABASE_PASSWORD
GAME_DATABASE_PORT
AUTH_DATABASE_IP
AUTH_DATABASE_NAME
AUTH_DATABASE_USERNAME
AUTH_DATABASE_PASSWORD
AUTH_DATABASE_PORT
Required for LIVE, Optional for Dev
Variable Default Description
HTTP_SERVER_BIND_IP 127.0.0.1 The IP for the HTTP server to bind to
HTTP_SERVER_PASS 0E0CECB2B6808B3BECDF28936DE54AE6481 The authentication key for the HTTP API
SENTRY_DSN Disabled Sentry DSN
DISCORD_BOT_TOKEN Disabled Discord Bot Token
DISCORD_CLIENT_ID Disabled Discord Application Client ID
ELASTICSEARCH_HOSTS
ELASTICSEARCH_USERNAME `` The authentication username for the ElasticSearch server
ELASTICSEARCH_PASSWORD `` The authentication password for the ElasticSearch server
Obtaining RAGE
You can obtain a verified working version of Rage server from the Releases page on GitHub. Please choose the highest revision and extract it into Owl -> V -> Output -> .
Alternatively, you can deploy any version of RAGE you wish by simply copying the server binaries from your rage server folder and copying in the C# Bridge which is found on the forums (
After copying in your binaries, you will have to compile the source code which runs the cooker, which will copy all server output into the folder above.
Generating Events
The script uses generated RAGE events (network & UI) via JSON manifest files. These files are located in \EventDescriptors\Network\ and \EventDescriptors\UI\
Any time you add or modify an event, you must run the GenerateEvents.bat file.
Adding New Scripts & Resources
All content in OwlV is cooked into archive files which are validated during cooker time, and loaded by the server. This cook/validation step helps avoid runtime issues and makes deployment easier.
Anytime you add, remove or modify (the file name, not contents), you must update the associated JSON descriptor in \Descriptors\
Files are defined by providing their filename, and type (e.g. ClientScript, ServerScript, etc) - please refer to existing descriptors for reference.
Using the Cooker
By default, the cooker uses symbolic links to allow for fast / near-instant iteration times. In 'Debug Full Cook' and 'Release' targets, a full cook, including code analysis, archive and unarchive are performed.
OwlV requires Windows Developer Mode to be enabled. This can be enabled by going to Start -> Developer Mode -> and checking the first checkbox.
Build Configurations
Debug x64 - Recommended for development, also enables 'fast iteration mode' for faster dev times
Debug Full Cook x64 - Simulates a release style cook, but uses debug binaries. Only recommended for diagnosing cook issues
Release x64 - Recommended for your server build
For running in debugger, you should start the Boot project as your startup project.
What variables should be I be changing?
You can search the code base for "TODO_GITHUB" for variables which you will want to update.
Please also refer to the environment variables below, which are required.
Database Configuration
The database connections must be configured before running the server. Set the following environment variables:
GAME_DATABASE_IP
GAME_DATABASE_NAME
GAME_DATABASE_USERNAME
GAME_DATABASE_PASSWORD
GAME_DATABASE_PORT
AUTH_DATABASE_IP
AUTH_DATABASE_NAME
AUTH_DATABASE_USERNAME
AUTH_DATABASE_PASSWORD
AUTH_DATABASE_PORT
Web Server Configuration
The game server runs a web server for remote UCP calls. The user is always ucp. Calling URL is
[To see links please register here]
By default this will only bind to 127.0.0.1. Set the environment variable below to bind to an external IP (required for LIVE server):HTTP_SERVER_BIND_IP
HTTP_SERVER_PASS
HTTP_SERVER_WHITELIST The IP that will be making calls
Configuration
The following environment variables can be used to tweak settings:
Required
GAME_DATABASE_IP
GAME_DATABASE_NAME
GAME_DATABASE_USERNAME
GAME_DATABASE_PASSWORD
GAME_DATABASE_PORT
AUTH_DATABASE_IP
AUTH_DATABASE_NAME
AUTH_DATABASE_USERNAME
AUTH_DATABASE_PASSWORD
AUTH_DATABASE_PORT
Required for LIVE, Optional for Dev
Variable Default Description
HTTP_SERVER_BIND_IP 127.0.0.1 The IP for the HTTP server to bind to
HTTP_SERVER_PASS 0E0CECB2B6808B3BECDF28936DE54AE6481 The authentication key for the HTTP API
SENTRY_DSN Disabled Sentry DSN
DISCORD_BOT_TOKEN Disabled Discord Bot Token
DISCORD_CLIENT_ID Disabled Discord Application Client ID
ELASTICSEARCH_HOSTS
[To see links please register here]
The hosts for the ElasticSearch server, delimited by spacesELASTICSEARCH_USERNAME `` The authentication username for the ElasticSearch server
ELASTICSEARCH_PASSWORD `` The authentication password for the ElasticSearch server
Obtaining RAGE
You can obtain a verified working version of Rage server from the Releases page on GitHub. Please choose the highest revision and extract it into Owl -> V -> Output -> .
Alternatively, you can deploy any version of RAGE you wish by simply copying the server binaries from your rage server folder and copying in the C# Bridge which is found on the forums (
[To see links please register here]
).After copying in your binaries, you will have to compile the source code which runs the cooker, which will copy all server output into the folder above.
