Skip to content

Godot 3.x project template that can do both (vr and 'normal' 3d game)

License

Notifications You must be signed in to change notification settings

lunarcloud/godot-both-flat-and-vr

Repository files navigation

Godot Project that Supports Both Flat & XR

icon

This project template enables your game to play as both an XR and a 'normal', a.k.a 'flat', 3D game).

Project Settings

MSAA "AndroidVR 2x" is recommended; it applies a 2x MSAA for both desktop and Quest platforms.

Inputs expected by the project's code are: "character_forward", "character_backward", "character_left", "character_right".

Autoload Singleton

There is one singleton to define under the "AutoLoad" section. the script "xr_or_flat_mode_singleton.gd" must be named "XrOrFlatMode". This singleton is the helper that allows any script to preform functions that differ between modes and to query the current mode.

autoload-singleton

Export For Meta Quest

Simply add the "always-xr" feature to the android export.

Don't forget to setup the usual settings like "XR Mode" as "OpenXR".

export-for-exclusively-xr-platform

Autodetect

If no OS feature is enforcing a mode, or the in-engine selector, it will select a mode based on whether it can start in XR mode or not.

Specify Mode via argument

  • Use "--flat", "--flat=true", or "--xr=false" for standard flat mode.
  • Use "--xr" or "--xr=true" for XR mode.

Providing Launch Options in Launcher App

This is intended to be used with itch.io's "Manifest actions" feature, where one can create different ways to launch a game.