Add OpenXR demo project showing off local reference space #1012

BastiaanOlij · 2024-01-27T14:29:06Z

This demo shows off how to create a vehicle centric XR game using OpenXR.

The basic idea is a simple go-kart race game.
Important here is the use of the "local" reference space.

It also shows mixing traditional inputs (keyboard/gamepad/steering wheel) with XR input.

If the player uses their controllers and holds them near the steering wheel, they will snap into place and the player will be able to turn the wheel. The triggers on the controller are used to accelerate (right controller) and brake (left controller)

BastiaanOlij · 2024-01-27T14:30:21Z

For those who are interested in this, recording of the stream in which I build the first part of this demo: https://youtube.com/live/eWpNwrPTiqw

BastiaanOlij · 2024-02-11T13:13:36Z

I've added a Gokart model from sketchfab that is CC-BY-4.0, hopefully that is acceptable here, else I'll need to look into another one.

This also has a little display on the steering wheel that we've used to display FPS and velocity information. Nice little touch.

Also added a polyhaven skytexture.

capnm · 2024-02-11T17:03:11Z

xr/openxr_vehicle_movement/assets/uv.jpg

Maybe you could add a separate licences folder, e.g. this one states that the generated textures are of free use.
https://uvchecker.vinzi.xyz/EULA.html
https://uvchecker.vinzi.xyz/

xr/openxr_vehicle_movement/start_vr.gd

BastiaanOlij · 2024-03-13T06:10:33Z

xr/openxr_vehicle_movement/assets/uv.jpg

Maybe you could add a separate licences folder, e.g. this one states that the generated textures are of free use. https://uvchecker.vinzi.xyz/EULA.html https://uvchecker.vinzi.xyz/

I ended up removing it as I only used it temporarily.

xr/openxr_vehicle_movement/.gitattributes

aaronfranke · 2025-10-02T06:32:22Z

xr/openxr_vehicle_movement/InfoUI.gd

+extends CanvasLayer
+
+func set_velocity(p_velocity : float):
+	%Velocity.text = "Velocity: %0.2f kmph (%0.2f m/s)" % [ p_velocity * 3.6, p_velocity ]
+
+# Called every frame. 'delta' is the elapsed time since the previous frame.
+func _process(delta):


Please follow the GDScript style guide, and use static typing, for all code in the demos.

We should fix all warnings before merging, such as by adding _ before delta.

Kilometers per hour is km/h not kmph. Also, I'd argue we should use meters per second as the primary (or only) unit, since it's the unit of velocity Godot users are working with in code.

Suggested change

extends CanvasLayer

func set_velocity(p_velocity : float):

%Velocity.text = "Velocity: %0.2f kmph (%0.2f m/s)" % [ p_velocity * 3.6, p_velocity ]

# Called every frame. 'delta' is the elapsed time since the previous frame.

func _process(delta):

extends CanvasLayer

func set_velocity(p_velocity: float) -> void:

%Velocity.text = "Velocity: %0.2f m/s (%0.2f km/h)" % [p_velocity, p_velocity * 3.6]

func _process(_delta: float) -> void:

aaronfranke · 2025-10-02T06:32:56Z

xr/openxr_vehicle_movement/assets/gokart/SeparatedMeshes/FrontWheel.mesh

All file names should use snake_case, only composed of lowercase, underscores, dots, and maybe numbers.

aaronfranke · 2025-10-02T06:36:09Z

xr/openxr_vehicle_movement/assets/gokart/scene.gltf

+          ]
+        }
+      },
+      "name": "Material.004"


We should ideally clean up the original 3D model file, at least such that it will have human-readable names for its parts, but we could go even further, such as including physics in the model. I could work on this but it's not a high priority for me.

AThousandShips · 2025-07-10T16:17:02Z

xr/openxr_vehicle_movement/InfoUI.gd

+# Called every frame. 'delta' is the elapsed time since the previous frame.
+func _process(delta):


Suggested change

# Called every frame. 'delta' is the elapsed time since the previous frame.

func _process(delta):

func _process(delta):

AThousandShips · 2025-07-10T16:17:08Z

xr/openxr_vehicle_movement/InfoUI.gd

@@ -0,0 +1,8 @@
+extends CanvasLayer
+
+func set_velocity(p_velocity : float):


Suggested change

func set_velocity(p_velocity : float):

func set_velocity(p_velocity: float):

AThousandShips · 2025-07-10T16:18:04Z

xr/openxr_vehicle_movement/README.md

+
+## Input and the action map
+
+This demo uses Godots standard input map to allow for keyboard and gamepad input.


Suggested change

This demo uses Godots standard input map to allow for keyboard and gamepad input.

This demo uses Godot's standard input map to allow for keyboard and gamepad input.

AThousandShips · 2025-07-10T16:18:16Z

xr/openxr_vehicle_movement/README.md

+There is also an action map setup so you can use the XR controllers.
+Move your hands close enough to the steering wheel so they grab the wheel,
+this will disable traditional input and enable you to control the steering wheel with your hands.
+You can then use the trigger on the left controller to accellerate, and the trigger on the right controller to break.


Suggested change

You can then use the trigger on the left controller to accellerate, and the trigger on the right controller to break.

You can then use the trigger on the left controller to accelerate, and the trigger on the right controller to break.

AThousandShips · 2025-07-10T16:19:59Z

xr/openxr_vehicle_movement/objects/black_out.gd

+		$Label3D.visible = false
+		set_process(false)
+	else:
+		# Update fade


Suggested change

# Update fade

# Update fade.

For all

AThousandShips · 2025-07-10T16:22:33Z

xr/openxr_vehicle_movement/track.gd

+		if is_inside_tree():
+			_update_tires()
+
+func _update_tires():


Suggested change

func _update_tires():

func _update_tires():

AThousandShips · 2025-07-10T16:22:45Z

xr/openxr_vehicle_movement/vehicle.gd

+	if material:
+		material.set_shader_parameter("albedo_texture", %InfoViewport.get_texture())
+
+# Called every frame. 'delta' is the elapsed time since the previous frame.


Suggested change

# Called every frame. 'delta' is the elapsed time since the previous frame.

# Called every frame. 'delta' is the elapsed time since the previous frame.

AThousandShips · 2025-07-10T16:22:54Z

xr/openxr_vehicle_movement/vehicle.gd

+
+# Called every frame. 'delta' is the elapsed time since the previous frame.
+func _process(delta):
+	# Check steering


Suggested change

# Check steering

# Check steering.

For all

AThousandShips · 2025-07-10T16:23:01Z

xr/openxr_vehicle_movement/vehicle.gd

+			steering_input = 1.0
+	else:
+		steering_input = Input.get_axis("turn_left", "turn_right")
+	steering = steering_input * -MAX_STEERING_ANGLE


Suggested change

steering = steering_input * -MAX_STEERING_ANGLE

steering = steering_input * -MAX_STEERING_ANGLE

AThousandShips · 2025-07-10T16:23:10Z

xr/openxr_vehicle_movement/vehicle.gd

+		elif just_pressed_accel:
+			reverse = false
+
+	if !reverse:


Suggested change

if !reverse:

if not reverse:

BastiaanOlij added the topic:xr label Jan 27, 2024

BastiaanOlij self-assigned this Jan 27, 2024

BastiaanOlij force-pushed the openxr_vehicle_demo branch from d256e73 to d1206e9 Compare February 11, 2024 13:12

AThousandShips reviewed Mar 7, 2024

View reviewed changes

xr/openxr_vehicle_movement/start_vr.gd Outdated Show resolved Hide resolved

BastiaanOlij force-pushed the openxr_vehicle_demo branch 6 times, most recently from d6df5e8 to 98483a9 Compare March 13, 2024 06:09

BastiaanOlij marked this pull request as ready for review March 13, 2024 06:10

BastiaanOlij force-pushed the openxr_vehicle_demo branch 3 times, most recently from d77ba52 to 3a74158 Compare March 18, 2024 02:34

BastiaanOlij requested a review from Malcolmnixon March 21, 2024 23:42

aaronfranke reviewed Apr 12, 2024

View reviewed changes

xr/openxr_vehicle_movement/.gitattributes Outdated Show resolved Hide resolved

Add OpenXR demo project showing off local reference space

670de95

BastiaanOlij force-pushed the openxr_vehicle_demo branch from 3a74158 to 670de95 Compare June 2, 2024 03:54

aaronfranke requested changes Oct 2, 2025

View reviewed changes

AThousandShips reviewed Oct 2, 2025

View reviewed changes

aaronfranke added the needs work label Oct 3, 2025

		# Called every frame. 'delta' is the elapsed time since the previous frame.
		func _process(delta):

		@@ -0,0 +1,8 @@
		extends CanvasLayer

		func set_velocity(p_velocity : float):

	func set_velocity(p_velocity : float):
	func set_velocity(p_velocity: float):


		## Input and the action map

		This demo uses Godots standard input map to allow for keyboard and gamepad input.

	This demo uses Godots standard input map to allow for keyboard and gamepad input.
	This demo uses Godot's standard input map to allow for keyboard and gamepad input.

	You can then use the trigger on the left controller to accellerate, and the trigger on the right controller to break.
	You can then use the trigger on the left controller to accelerate, and the trigger on the right controller to break.

	steering = steering_input * -MAX_STEERING_ANGLE

	steering = steering_input * -MAX_STEERING_ANGLE

Uh oh!

Add OpenXR demo project showing off local reference space #1012

Are you sure you want to change the base?

Add OpenXR demo project showing off local reference space #1012

Uh oh!

Conversation

BastiaanOlij commented Jan 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BastiaanOlij commented Jan 27, 2024

Uh oh!

BastiaanOlij commented Feb 11, 2024

Uh oh!

capnm commented Feb 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

BastiaanOlij commented Mar 13, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

BastiaanOlij commented Jan 27, 2024 •

edited

Loading

capnm commented Feb 11, 2024 •

edited

Loading