Programming & Scripting Archives - RIDE

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Shows how to leverage commodity text-to-image generative AI services through REST calls, using RIDE’s common web services system.

Leverages RIDE’s Generative AI and Image Generation Interfaces which implement OpenAI DALL-E and Stability AI Stable Diffusion.

Current Providers

OpenAI DALL-E
Stability AI Stable Diffusion

How to Use

IMPORTANT

If you wish to use the ExampleImageGeneration scene and related web services, you must update your local RIDE config file (ride.json). Please back-up any local changes to the file, including your terrain key. Next, restore your Config to default using the corresponding option in the Config debug menu at run-time, then reapply any customization and terrain key. Refer to the Config File page within Support for more information.

Provider Comparison UI

Input text in the bottom field and hit enter or click the Send Prompt. Any input will be sent to both providers simultaneously.
Each service has its own pane which populates with the following information after entering a query:
1. Time to generate and receive
2. Returned image from the provider

Scene Location & Name

Assets/Ride/Examples/ExampleImageGeneration.unity

Setup Requirements

The ExampleImageGeneration scene utilizes a customizable UI and interchangeable service providers through canvas, scripts and prefabs. Explore the objects in the Hierarchy view for the scene inside the Unity editor and source via the API documentation.

The main script is ExampleImageGeneration.cs in the same folder.

The post Image Generation Comparison appeared first on RIDE.

OAuth

Andrew Leeds — Wed, 09 Nov 2022 23:56:00 +0000

Programming & Scripting

OAuth

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

This example demonstrates how to use Google and Facebook OAuth authentication systems within RIDE.

How to Use

Facebook

Choose Facebook.
Fill in the things as under from Setup Requirements section below:
1. Firebase API Key: Step-2.
2. Facebook App ID: Step-9(j).
3. Facebook App Secret: Step-9(j).
4. Redirect / SaveAuthToken URL: Step-5(n)-i.
5. GetAuthToken URL: Step-5(n)-ii.
Click on Login Facebook button verifying everything in Step-2 and it will redirect you to the web page to ask Allow login to Facebook. Enter your Facebook credentials and click Continue.
A webpage will pop up telling to return to the app and you will see your name, email and profile picture pop up in the Unity App indicating that the login was successful.
Click the Clear button to clear the account profile pic, email, and name.
Click Back to return to the login selection menu.

Google

Choose Google.
Fill in the things as under from Setup Requirements section below:
1. Firebase API Key: Step-2.
2. Google Client ID: Step-7(a)-i.
3. Google Client Secret: Step-7(a)-i.
4. Redirect / SaveAuthToken URL: Step-5(n)-i.
5. GetAuthToken URL: Step-5(n)-ii.
Click on Login Google button verifying everything in Step-2 and it will redirect you to the web page to ask Allow login to Google. Enter your Google credentials or choose from a list of accounts.
A webpage will pop up telling you to return to the app and you will see your email pop up in the Unity App indicating that the login was successful.
Click the Clear button to clear the account profile pic, email, and name.
Click Back to return to the login selection menu.

Scene Location & Name

Assets/Ride/Examples/OAuth/Scenes/ExampleOAuth.unity

Scene Setup

The example Unity scene directory contains the backend scripts related to the authentication services that are presented in a custom UI within the scene: ExampleOauth.cs, FirebaseAuthHandler.cs, GoogleAuthenticator.cs, FacebookAuthenticator.cs, FacebookIdTokenResponse.cs and GoogleIdTokenResponse.cs.

Server Setup

Enable custom authentication cloud services for your own project using the following process:

Create a Google Cloud project which will act as the master project in the Google Cloud Console https://console.cloud.google.com/. Make sure you have the developer or admin privileges.
Go to Firebase console https://console.firebase.google.com/ and you will see the same project already there. Select it. Keep a note of the Web API Key under Project Overview→Project Settings.
1. Note, the key may not appear immediately. Navigate to Authentication and step through the various tabs (Users, etc.) then return to the Project Settings whereupon it should now populate.
Next, create a new database for logging all related services data.
1. In the Firebase console, navigate to Build→Realtime Database.
2. Click Create Database button.
3. Click Next in the prompt.
4. Choose Start in Locked Mode.
5. Click Enable.
6. Empty database with corresponding URL should now appear in the main pane.
In the Build→Functions section we need to create and invoke two cloud functions.
1. Firebase Cloud Function is a backend for Firebase that lets user deploy JavaScript/TypeScript code onto Firebase and then run it when required. It is used here as a web page to retrieve the authentication code required to get a user sign in to Google, Facebook or any other providers.
Invoking Cloud Function on Firebase Server:
1. Go to https://nodejs.org/en/ and install nodejs to get the npm package installed in the system. To verify if installation was successful, type npm in command prompt and see you get no errors.
2. Create a new folder on the desktop, naming it as desired. Open a new command prompt and change the path to that folder.
3. Install Firebase tools using command, npm install -g firebase-tools.
  1. Once complete, recommend running ‘npm audit fix’ if vulnerabilities are reported.
4. Login to your Firebase account using command, firebase login. It will open a browser window where you can login to your Firebase console.
  1. Answer Y or n regarding usage and error reporting information collection.
  2. Choose Allow for Firebase CLI access to your Google Account.
    1. A Firebase CLI login successful prompt will appear. Close and return to the command prompt window.
5. Initiate Firebase instance using command, firebase init.
6. Type Y to proceed.
7. Choose Functions: Configure a Cloud Functions directory and its files.
8. Choose Use existing [Firebase] project and choose it from the next option that pops up.
9. Choose JavaScript as the language.
10. Type N for Do you want to use ESLint to catch probable bugs and enforce style?.
11. Type Y for Do you want to install dependencies with npm now?
  1. Once complete, you now have your firebase initialized!
12. Copy file Assets\StreamingAssets\oauth\FirebaseCloudFunctions\index.js from the RideUnity project and replace the existing \functions\index.js to set the custom cloud function that will be deployed.
13. Run command firebase deploy from the same command prompt to deploy it into the Firebase server.
14. If everything was followed then you should see two functions named saveAuthToken and getAuthToken in the Functions section of the Firebase console with their respective associated endpoints as triggers.
  1. saveAuthToken endpoint: https://-.cloudfunctions.net/saveAuthToken
  2. getAuthToken endpoint: https://-.cloudfunctions.net/getAuthToken
Google Cloud OAuth Consent Screen:
1. In the Google Cloud console, go to API & Services→OAuth consent screen.
  1. Edit app registration, User Type, choose External, and click on CREATE.
  2. App information section fields:
    1. App name, enter custom name.
    2. User support email, enter desired email.
    3. App logo, add an image (optional).
  3. Develop contact information fields.
    1. Email address, use same email as above, add others as desired.
  4. Click SAVE AND CONTINUE.
  5. Scopes, leave as-is, click SAVE AND CONTINUE.
  6. Optional info, leave as-is, click SAVE AND CONTINUE.
  7. Summary, review and click BACK TO DASHBOARD.
Google Cloud Credentials:
1. In the Google Cloud console, click API & Services→Credentials
  1. OAuth2.0 Client IDs section, click entry name, “Web client (auto created by Google Service)”.
    1. Authorized JavaScript origins entries, ensure “URIs 3” populated with “https://.firebaseapp.com” address.
    2. Authorized redirect URIs section, click on ADD URI, and add the SaveAuthToken endpoint generated in step-5(n)-i.
    3. Click on SAVE.
    4. Important, keep a note of the Client ID and Client secret entries listed in the upper-right.
      1. Note, if Client secret fails to appear, click RESET SECRET, then in the prompt, click RESET to generate it.
Firebase Google Login:
1. Enable Google sign-in method in Firebase console:
  1. Go to the Firebase console under Build, Authentication→Sign-in method→Add new provider button, choose Google to add it into the list of providers.
2. In the Configure provider pane, click the toggle to Enable, then click Save.
  1. Under Google→Web SDK configuration set the Web client ID and Web client secret from Step-5d. (Note, if not already auto-filled.)
Facebook Login
1. Prerequisite: Ensure you have a Facebook Developer Account (see link below).
2. Create a Facebook app in https://developers.facebook.com/.
  1. Registration steps:
    1. Login or create Facebook account.
    2. Facebook for Developers, Welcome page, click Continue.
    3. Verify account using mobile number.
    4. Contact info email confirmation.
    5. Choose About you option and Complete Registration.
  2. Meta for Developers dashboard:
    1. If you do not yet have an app, click Create App.
      1. Select Consumer, click Next.
      2. Basic information screen:
        Add an app name field, input a unique name.
        Click Create app button.
3. Return to Meta for Developers dashboard.
4. Add product, Facebook Login, click Set up (hold off on further changes until indicated in step 9(g) below).
5. Under sidebar Settings→Basic:
  1. Under App domains, set the domain from step-5(n) i.e. https://-.cloudfunctions.net
  2. Under Privacy Policy URL, set it to your company’s privacy policy URL.
  3. Under User data deletion, set it to your company’s data deletion instructions or callback URL.
  4. Click bottom option, Add platform.
    1. Select Website and add url from step-5(n) under Site URL.
  5. Click on Save changes.
6. Under Settings→Advanced:
  1. Turn on Native or desktop app?
7. Under Products→Facebook Login→Settings:
  1. Set Client OAuth login to Yes.
  2. Set Web OAuth login to Yes.
  3. Set Enforce HTTPS to Yes.
  4. Set Use Strict Mode for redirect URIs to Yes.
  5. Set Valid OAuth Redirect URIs to url in step-5(n)-i.
8. Click on Save changes.
9. In the top of the window set the App Mode to Live.
10. Under Settings→Basic keep a note of the App ID and App Secret.
Firebase Facebook Login
1. Enable Facebook sign-in method in Firebase console:
  1. Go to the Firebase console under Authentication→Sign-in method→Add new provider, choose Facebook to add it into the list of providers.
  2. Under Facebook, set the App ID and App secret from Step-9(j).
Firebase Database Rules:
1. In the Realtime Database section in the Firebase console, under Rules make sure to disable read/write so that no user can access the project but just make authentication requests.

The post OAuth appeared first on RIDE.

File Storage System

Andrew Leeds — Mon, 05 Apr 2021 23:56:27 +0000

Programming & Scripting

File Storage System

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Shows how to upload and download files from cloud services AWS S3 and Azure Blob.

How to Use

Hit play and examine the unity console to see the downloading and uploading logs output by the file storage systems.

Scene Location & Name

Assets/Ride/Examples/Services/File/ExampleFileStorageSystem.unity

Setup Requirements

The “Example” game object has the ExampleFileStorageSystem attached to it. This script creates the IFileStorageSystems AWSFileStorageS3System and AzureBlobFileStorageSystem.

The post File Storage System appeared first on RIDE.

RIDE API Basics

Andrew Leeds — Wed, 27 Jan 2021 18:34:04 +0000

Programming & Scripting

RIDE API Basics

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Demonstrates how to spawn and move opposing agents as well as listen to world events.

Purpose

Establish groups for agents and relationships between the groups.

How to Use

Hit play and see 3 different agents spawn, an opfor, a blufor, and a civilian. All of the agents will begin to move and the opfor and blufor will attack each other. In the on screen log, you will see events that are happening during the course of the simulation.

Scene Location & Name

Assets/Ride/Examples/Groups/ExampleApiFunctions.unity

Setup Requirements

The ExampleApiFunctions script was added to the game object named “Example”.

A navigation mesh was generated from the plane in the scene.

ExampleApiFunctions Script

Add this script to an object in your scene to spawn and move agents and listen to world events. Modify as needed to suit your own needs.

The post RIDE API Basics appeared first on RIDE.

Time Simulation

Andrew Leeds — Wed, 13 Jan 2021 19:12:35 +0000

Programming & Scripting

Time Simulation

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Demonstrates how to control simulation time speed and unit movement speed.

How to Use

The top options in the debug menu are used to spawn and select agents. With the agents selected, set at least one waypoint to begin unit movement. Adjust the Time and Movement Speed sliders to speed up or slow down these aspects of the simulation.

With Should Loop enabled, units will navigate between the selected waypoints.

Click Clear Agent(s) to remove the selected agents.

This scene features the Catalina Island OWT dataset for its diverse terrain, as such the waypoints chosen vary in difficulty for the A* Pathing navigation of units.

Scene Location & Name

Assets/Ride/Examples/TimeSimulation/ExampleTimeSimulation.unity

Setup Requirements

The ITimeSimulationSystem allows you to speed up, slow down, stop, and resume the simulation. Utilize the ITimeSimulationSystem API for your scene and its agents by adding the ExampleTimeSimulation script.

ExampleTimeSimulation Script

Add this script to an object in your scene to enable the use of the ITimeSimulationSystem. In this script, UI widget presses are handled to set the time simulation speed via the service.

The post Time Simulation appeared first on RIDE.

Razish Tour

Andrew Leeds — Fri, 08 Jan 2021 00:57:31 +0000

Programming & Scripting

Razish Tour

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

This example scene shows how to create an interactive tour around a terrain using scenario events and custom AI behaviors. In this example, the player tours the fictional city of Razish, located in the real world at the National Training Center at Ft. Irwin, California.

How to Use

This example scene begins with an overhead view and fly-through of the city of Razish, with a moving camera and a recorded audio clip. When this introductory fly-through is finished, you take on the role of an Iraqi woman following her two friends and their two children on a walking tour of Razish. Maneuver your avatar using the W-A-S-D keys on your keyboard or with a gamepad controller. When you arrive at each tour stop, an audio clip describing the site will be triggered. At the end of the walking tour, the scene will return to an overhead view for a final fly-through of the city.

Scene Location & Name

Assets/Ride/Examples/Scenarios/RazishTour/RazishTour.unity

Setup Requirements

Scenario System

Utilize the RIDE Scenario System to create Scenario Events that are triggered by Scenario Conditions. Several built-in scenario events and scenario conditions are provided by the RIDE platform. This example scene demonstrates several types of built-in Scenario Event types, including an AgentBehaviourScenarioEvent to assign the TourBehaviour to the tour guide agent, and an AudioScenarioEvent to play clips using RIDE’s Audio System.

Custom Scenario Events

Utilize a CustomScenarioEvent in order to execute arbitrary code when Scenario Conditions are met. This example scene demonstrates several instances of CustomScenarioEvent, including the switching from overhead view to control of an avatar, the programmed camera movements of the two fly-through sequences.

Observation Scenario Conditions

Utilize an ObservationScenarioCondition to create a Scenario Condition for any arbitrary World Event that is dispatched by RIDE, and represented an logical (symbolic) form by RIDE’s Interpretation System. In this example, an ObservationScenarioCondition is triggered when the Interpretation System encodes a FlagCaptured World Event. Please see Interpretation System documentation for details on writing patterns for ObservationScenarioConditions.

The post Razish Tour appeared first on RIDE.

VGL Stress Test

Andrew Leeds — Sat, 14 Nov 2020 07:08:11 +0000

Programming & Scripting

VGL Stress Test

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Configure a scalability test with generic in-game agents in real-time and record performance data locally and in the cloud for later analysis.

How to Use

Allow the terrain in the scene to populate. Once finished, the Run Test 01 button will appear in the upper left. Upon click, this will initialize a brief test that spawns 100 instances of the full_genericAvatar model. Ideally, these models will appear to walk smoothly in a circle depending on hardware capability. If running the scene in the Unity editor, you may observe the scene’s frame rate in real-time with the Stats overlay.

The current test will last for 5 seconds, and when complete, will automatically generate a performance output file using the Unity Profiler utility in .json format that will save to the following location within the project directory on disk: /Assets

Additionally, a copy of the output file will upload automatically to the RIDE AWS and Azure cloud storages.

Example output file content:

				
					
"$id": "1",
"os": "Windows 10 (10.0.0) 64bit",
"numProcessors": 8,
"sysMemorySize": 32.696,
"gfxDeviceName": "NVIDIA GeForce GTX 1080",
"gfMemorySize": 8079,
"usedHeapSize": 440311680.0,
"resolutionWidth": 1280,
"resolutionHeight": 720,
"scenario": "ExampleVGLStressTest",
"numCivs": 100,
"duration": 5.0,
"civVertCountSingle": 42547,
"civVertCountTotal": 4254700,
"avgfps": 74.2840652

Note, no user specific information is contained within the file.

Using REST to Control the Scenario

This scenario can be controlled via REST. After the scenario loads, enter the following url into your browser:

http://127.0.0.1:9157/ScenarioService/BeginSimulation/?civs=100&duration=5

civs = The number of civilians to spawn

duration = The length of time to run the simulation before clearing the scenario and logging the performance data

Scene Location & Name

Assets/Scenes/PatternsOfLife/VGL/ExampleVGLStressTest.unity

Setup Requirements

Utilize a similar scalability test for your scene and specific assets by adding the ExampleVGLStressTest script, ScenarioMenu UI and ResourceLoader (GOList) prefab.

ExampleVGLStressTest Script

First, add this script to an object in your scene to enable the example test and output file generation.

ScenarioMenu, ResourceLoader Prefab and Supporting Objects

Manually invoke the test through a simple UI by adding the ScenarioSettingsMenu script to an empty game object. In the Scenario field, choose your scene (ExampleVGHStressTest). Next, follow the example Panel construction to create the necessary buttons. Hide the ScenarioMenu object by unchecking its box in the Inspector so that it will not appear until after terrain load.

Instance the ResourceLoader prefab (commonly renamed as GOList) and add entries under Scene Game Objects for what you wish to spawn. In this example, VGL_Civilian00 and VGL_Civilian01. Instance these objects in the scene, but uncheck the box in the Inspector to hide them by default at start.

This examples scene contains the following prefabs and scripts related to terrain:

TerrainLoader
TerrainCamera
RazishNavmesh

The Waypoint layer contains multiple Waypoint_AutoAddToRide prefab objects used to move scene objects to a destination at run-time. In the example, waypoints are placed in a circle around a central point of interest in the terrain map.

The post VGL Stress Test appeared first on RIDE.

Vehicles Input

Andrew Leeds — Sat, 14 Nov 2020 07:02:50 +0000

Programming & Scripting

Vehicles Input

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Navigate terrain maps with “drivable” vehicles through basic keyboard or gamepad input. Cycle multiple camera angles in and around the vehicle for observation of variables in the environment that affect physics of the vehicles, such as the suspension’s handling over “bump” objects. An overlay displays vehicle motion statistics in real-time.

How to Use

Vehicle navigation controls vary by input device:

Keyboard:
1. Accelerate/Reverse – W/S or Up/Down arrow keys
2. Turn left/right – A/D or Left/Right arrow keys
Gamepad/Controller:
1. Accelerate/Reverse – Up/Down on left analog thumb-stick
2. Turn left/right – Left/Right arrow key on left analog thumb-stick

Switch camera angles by pressing the C key. Note, when at first-person view in the driver position, use mouse-look to change the camera orientation.

Exit and enter the vehicle by toggling the T key.

Enable the handbrake by holding the Space bar.

Pause the game by toggling the P key.

Note, the R key will call a function that attempts to reload the scene. This currently fails in the example scene.

The corner overlay displays the following values:

Gear
Velocity (km/h)
Velocity (mp/h)
Handbrake
Pause

Scene Location & Name

Assets/Ride/Examples/Vehicles/ExampleVehiclesInput.unity

Setup Requirements

Utilize vehicle controls and first-person camera API for your scene by adding the following prefabs, which their respective scripts:

Assets/Ride_Dependencies/MSVehicleSystem(FreeVersion)/Prefabs/Control.prefab
Assets/Ride_Dependencies/MSVehicleSystem(FreeVersion)/Prefabs/MSFPSController.prefab
Assets/Ride_Art/Art/Characters/MiddleEast/Legacy/Resources/RideEntities/VehicleInputControllerPrefab.prefab (VehHmvM111402)

Note, the VehicleInputControllerPrefab contains the humvee model from Bravemind. Reference setup of this prefab when adding your own vehicle model to a custom prefab. Add the following script to the root of your prefab to enable vehicle control:

Assets/Ride_Dependencies/MSVehicleSystem(FreeVersion)/Scripts/MSVehicleControllerFree.cs

The example scene contains an OWT terrain map, collision mesh, and start point, represented by objects TerrainLoader, RazishNavmesh and TerrainCenter.

Note, the Scenario object is for testing purposes only, and belongs to the MSVehicleSystem(FreeVersion) 3rd party package.

Control Prefab w/MSSceneControllerFree Script

First, add the Control prefab to your scene and in the Vehicles > Element 0 field, add your vehicle prefab. Next, in the Player field, add the MSFPSController prefab once instanced in your scene.

This prefab also contains the necessary Canvas child prefab.

MSFPSController Prefab and MSFPSController Script

Next, import the MSFPSController prefab into your scene for first-person controls of your avatar by way of the MSFPSController script. This prefab also contains the necessary Camera and Canvas child prefabs.

Remember to add this vehicle prefab in the Vehicles > Element 0 field of the Control prefab instanced in your scene.

VehHmvM111402Prefab Prefab and MSVehicleControllerFree Script

Next, import the VehHmvM111402Prefab prefab into your scene as the vehicle to be controlled by way of the MSVehicleControllerFree script.

This “game-ready” prefab contains all the necessary objects, including model, cameras, colliders, etc.

The post Vehicles Input appeared first on RIDE.

Unit Data

Andrew Leeds — Sat, 14 Nov 2020 06:54:56 +0000

Programming & Scripting

Unit Data

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees