| --- |
| license: cc-by-4.0 |
| tags: |
| - unreal-engine |
| - simulator |
| - windows |
| - vr |
| - quest |
| - escooter |
| --- |
| |
| # eScooter Simulator Unreal Engine Model |
|
|
| This repository contains the packaged Windows shipping build of the eScooter simulator created with Unreal Engine. |
|
|
| The simulator is designed for use with Meta Quest VR glasses in a Windows VR setup. It can also be used as a packaged Unreal Engine Windows application for testing, demonstration, and simulation workflows. |
|
|
| This release starts directly on the scooter riding map and does not require an in-app login. |
|
|
| ## Demo Video |
|
|
| <video controls width="100%" src="https://huggingface.co/sidaj/eScooter_simulator_UnrealEngine_Model/resolve/main/media/fellowbot-escooter-ad.mp4"> |
| Demo video: FellowBot eScooter simulator |
| </video> |
|
|
| If the embedded player does not load, open or download the video here: [fellowbot-escooter-ad.mp4](https://huggingface.co/sidaj/eScooter_simulator_UnrealEngine_Model/resolve/main/media/fellowbot-escooter-ad.mp4). |
|
|
| ## Contents |
|
|
| - `Windows/` - runnable Windows package |
| - `Windows/eScooter.exe` - launcher executable |
| - `Windows/eScooter/Content/Paks/` - Unreal Engine packaged assets |
| - `Windows/README_NO_LOGIN_RELEASE.txt` - release notes for the no-login telemetry build |
|
|
| ## Testing |
|
|
| This package is intended for testing the eScooter simulator experience on Windows with Quest VR glasses connected through a supported PC VR workflow (Meta Horizon Link -> Quest Link -> click the eScooter.exe at Desktop inside Quest glasses). |
|
|
| Before testing, install any required Unreal Engine prerequisites from the included redistributable if Windows prompts for missing runtime components. |
|
|
| ## Steering of escooter using Meta Quest |
|
|
| Before steering - Grasp of the handles: press A in right controller, then press X at the left controller |
|
|
| Acceleration / throttle: Right controller trigger |
|
|
| Steering: relatitve position between right and left hand controller similar to how you will turn in a real scooter |
|
|
| Brake: Left controller trigger |
|
|
| ## Local data log |
|
|
| This vehicle dynamics data e.g. speed, acceleration, steering angle, map levels will be stored locally: `%LOCALAPPDATA%\eScooter\Saved\Logs\eScooter_RideTelemetry.log` |
|
|
| The no-login release also posts anonymous ride telemetry to the hosted eScooter telemetry relay configured by the developer. |
|
|
| ## Data Example |
|
|
| A telemetry-only sample extracted from a KTH test session is included here: [data/eScooter_KTH_SJ2_telemetry_sample.log](data/eScooter_KTH_SJ2_telemetry_sample.log). |
|
|
| The sample keeps scooter dynamics lines and omits Unreal startup logs and local development paths. Each row includes timestamp/frame, actor, speed, throttle, brake, steering, location, level, turning angle, and student ID. |
|
|
| Example row: |
|
|
| ```text |
| [2024.03.27-17.00.28:252][913]LogBlueprintUserMessages: [TestScooterHands_C_UAID_84A938C6F55DFDE301_1830247399] Speed:0.051;Throttle:0.0;Brake:0.0;Steering:0;Location:-1,470;-2,710;22;Level:VehicleExampleMap;Turning Angle:0;StudentID:0; |
| ``` |
|
|
| ## Download Notes |
|
|
| The Windows package includes Unreal Engine binary assets and executable files stored with Git LFS. |
|
|
| ## Citation |
|
|
| For academic citation please refer to: [IEEE Xplore paper](https://ieeexplore.ieee.org/abstract/document/11423806) |
