#![allow(clippy::empty_docs)] mod core; mod nodes; mod objects; mod session; #[cfg(feature = "wayland")] mod wayland; use crate::core::destroy_queue; use crate::nodes::items::camera; use crate::nodes::{audio, drawable, input}; use bevy::MinimalPlugins; use bevy::a11y::AccessibilityPlugin; use bevy::app::{App, TerminalCtrlCHandlerPlugin}; use bevy::asset::{AssetMetaCheck, UnapprovedPathMode}; use bevy::audio::AudioPlugin; use bevy::core_pipeline::CorePipelinePlugin; use bevy::diagnostic::DiagnosticsPlugin; use bevy::ecs::schedule::{ExecutorKind, ScheduleLabel}; use bevy::gizmos::GizmoPlugin; use bevy::gltf::GltfPlugin; use bevy::input::InputPlugin; use bevy::pbr::PbrPlugin; use bevy::remote::RemotePlugin; use bevy::remote::http::RemoteHttpPlugin; use bevy::render::{RenderDebugFlags, RenderPlugin}; use bevy::scene::ScenePlugin; use bevy::text::FontLoader; use bevy_mod_openxr::action_set_attaching::OxrActionAttachingPlugin; use bevy_mod_openxr::action_set_syncing::OxrActionSyncingPlugin; use bevy_mod_openxr::add_xr_plugins; use bevy_mod_openxr::exts::OxrExtensions; use bevy_mod_openxr::features::overlay::OxrOverlaySettings; use bevy_mod_openxr::features::passthrough::OxrPassthroughPlugin; use bevy_mod_openxr::init::{OxrInitPlugin, should_run_frame_loop}; use bevy_mod_openxr::reference_space::OxrReferenceSpacePlugin; use bevy_mod_openxr::render::{OxrRenderPlugin, OxrWaitFrameSystem}; use bevy_mod_openxr::resources::{OxrFrameState, OxrFrameWaiter, OxrSessionConfig}; use bevy_mod_openxr::types::AppInfo; use bevy_mod_xr::camera::XrProjection; use bevy_mod_xr::hand_debug_gizmos::HandGizmosPlugin; use bevy_mod_xr::session::{XrFirst, XrHandleEvents}; use clap::Parser; use core::client::{Client, tick_internal_client}; use core::entity_handle::EntityHandlePlugin; use core::task; use directories::ProjectDirs; use nodes::drawable::lines::LinesNodePlugin; use nodes::drawable::model::ModelNodePlugin; use nodes::drawable::text::TextNodePlugin; use nodes::spatial::SpatialNodePlugin; use objects::ServerObjects; use objects::input::sk_controller::ControllerPlugin; use objects::input::sk_hand::HandPlugin; use objects::play_space::PlaySpacePlugin; use openxr::{EnvironmentBlendMode, ReferenceSpaceType}; use session::{launch_start, save_session}; use stardust_xr::schemas::dbus::object_registry::ObjectRegistry; use stardust_xr::server; use std::ops::DerefMut as _; use std::path::PathBuf; use std::sync::{Arc, OnceLock}; use std::time::Duration; use stereokit_rust::material::Material; use stereokit_rust::shader::Shader; use stereokit_rust::sk::{ AppMode, DepthMode, DisplayBlend, OriginMode, QuitReason, SkSettings, sk_quit, }; use stereokit_rust::system::{Handed, Input, LogLevel, Renderer}; use stereokit_rust::tex::{SHCubemap, Tex, TexFormat, TexType}; use stereokit_rust::ui::Ui; use stereokit_rust::util::{Color128, SphericalHarmonics, Time}; use tokio::net::UnixListener; use tokio::sync::Notify; use tracing::metadata::LevelFilter; use tracing::{debug_span, error, info}; use tracing_subscriber::{EnvFilter, fmt, prelude::*}; use zbus::Connection; use zbus::fdo::ObjectManager; use bevy::prelude::*; #[derive(Debug, Clone, Parser)] #[clap(author, version, about, long_about = None)] struct CliArgs { /// Force flatscreen mode and use the mouse pointer as a 3D pointer #[clap(short, long, action)] flatscreen: bool, /// If monado insists on emulating them, set this flag...we want the raw input #[clap(long)] disable_controllers: bool, /// If monado insists on emulating , set this flag...we want the raw input #[clap(long)] disable_hands: bool, /// Run Stardust XR as an overlay with given priority #[clap(id = "PRIORITY", short = 'o', long = "overlay", action)] overlay_priority: Option, /// Debug the clients started by the server #[clap(short = 'd', long = "debug", action)] debug_launched_clients: bool, /// Run a script when ready for clients to connect. If this is not set the script at $HOME/.config/stardust/startup will be ran if it exists. #[clap(id = "PATH", short = 'e', long = "execute-startup-script", action)] startup_script: Option, /// Restore the session with the given ID (or `latest`), ignoring the startup script. Sessions are stored in directories at `~/.local/state/stardust/`. #[clap(id = "SESSION_ID", long = "restore", action)] restore: Option, /// this should fix nvidia issues, it'll only help on driver 565+ /// and only if running under wayland, probably #[clap(long)] nvidia: bool, } static STARDUST_INSTANCE: OnceLock = OnceLock::new(); // #[tokio::main(flavor = "current_thread")] #[tokio::main] async fn main() { // let mut out = Vec::new(); // for i in 0..8 { // for base in [0, 8, 1, 8, 9, 1] { // out.push(base + i as u16); // } // } // panic!("{out:?}"); color_eyre::install().unwrap(); let registry = tracing_subscriber::registry(); #[cfg(feature = "profile_app")] let registry = registry.with( tracing_tracy::TracyLayer::new(tracing_tracy::DefaultConfig::default()) .with_filter(LevelFilter::DEBUG), ); #[cfg(feature = "profile_tokio")] let (console_layer, _) = console_subscriber::ConsoleLayer::builder().build(); #[cfg(feature = "profile_tokio")] let registry = registry.with(console_layer); let log_layer = fmt::Layer::new() .with_thread_names(true) .with_ansi(true) .with_line_number(true) .with_filter( EnvFilter::builder() .with_default_directive(LevelFilter::WARN.into()) .from_env_lossy(), ); registry.with(log_layer).init(); let cli_args = CliArgs::parse(); if cli_args.nvidia && !cli_args.flatscreen { // Only call this while singlethreaded since it can/will cause raceconditions with other // functions reading or writing from the env unsafe { std::env::set_var("__GLX_VENDOR_LIBRARY_NAME", "mesa"); std::env::set_var( "__EGL_VENDOR_LIBRARY_FILENAMES", "/usr/share/glvnd/egl_vendor.d/50_mesa.json", ); std::env::set_var("MESA_LOADER_DRIVER_OVERRIDE", "zink"); std::env::set_var("GALLIUM_DRIVER", "zink"); } } let socket_path = server::get_free_socket_path().expect("Unable to find a free stardust socket path"); STARDUST_INSTANCE.set(socket_path.file_name().unwrap().to_string_lossy().into_owned()).expect("Someone hasn't done their job, yell at Nova because how is this set multiple times what the hell"); info!( socket_path = ?socket_path.display(), "Stardust socket created" ); let socket = UnixListener::bind(socket_path).expect("Couldn't spawn stardust server at {socket_path}"); task::new(|| "client join loop", async move { loop { let Ok((stream, _)) = socket.accept().await else { continue; }; if let Err(e) = Client::from_connection(stream) { error!(?e, "Unable to create client from connection"); } } }) .unwrap(); info!("Init client join loop"); let project_dirs = ProjectDirs::from("", "", "stardust"); if project_dirs.is_none() { error!( "Unable to get Stardust project directories, default skybox and startup script will not work." ); } let dbus_connection = Connection::session() .await .expect("Could not open dbus session"); dbus_connection .request_name("org.stardustxr.HMD") .await .expect( "Another instance of the server is running. This is not supported currently (but is planned).", ); dbus_connection .object_server() .at("/", ObjectManager) .await .expect("Couldn't add the object manager"); let object_registry = ObjectRegistry::new(&dbus_connection).await.expect( "Couldn't make the object registry to find all objects with given interfaces in d-bus", ); let sk_ready_notifier = Arc::new(Notify::new()); let stereokit_loop = tokio::task::spawn_blocking({ let sk_ready_notifier = sk_ready_notifier.clone(); let project_dirs = project_dirs.clone(); let cli_args = cli_args.clone(); let dbus_connection = dbus_connection.clone(); move || { bevy_loop( sk_ready_notifier, project_dirs, cli_args, dbus_connection, object_registry, ) } }); sk_ready_notifier.notified().await; let mut startup_children = project_dirs .as_ref() .map(|project_dirs| launch_start(&cli_args, project_dirs)) .unwrap_or_default(); tokio::select! { _ = stereokit_loop => (), _ = tokio::signal::ctrl_c() => unsafe {sk_quit(QuitReason::SystemClose)}, } info!("Stopping..."); if let Some(project_dirs) = project_dirs { save_session(&project_dirs).await; } for mut startup_child in startup_children.drain(..) { let _ = startup_child.kill(); } info!("Cleanly shut down Stardust"); } static DEFAULT_SKYTEX: OnceLock = OnceLock::new(); static DEFAULT_SKYLIGHT: OnceLock = OnceLock::new(); #[derive(ScheduleLabel, Hash, Debug, PartialEq, Eq, Clone, Copy)] pub struct PreFrameWait; #[derive(Resource, Deref)] pub struct ObjectRegistryRes(ObjectRegistry); #[derive(Resource, Deref)] pub struct DbusConnection(Connection); fn bevy_loop( ready_notifier: Arc, project_dirs: Option, args: CliArgs, dbus_connection: Connection, object_registry: ObjectRegistry, ) { let mut app = App::new(); app.insert_resource(DbusConnection(dbus_connection)); app.add_plugins(AssetPlugin { meta_check: AssetMetaCheck::Never, unapproved_path_mode: UnapprovedPathMode::Allow, ..default() }); let mut plugins = MinimalPlugins .build() .add(DiagnosticsPlugin) .add(TransformPlugin) .add(InputPlugin) .add(AccessibilityPlugin); plugins = plugins .add(TerminalCtrlCHandlerPlugin) // bevy_mod_openxr will replace this, TODO: figure out how to mix this with // bevy-dmabuf .add(RenderPlugin::default()) .add(ImagePlugin::default()) .add(CorePipelinePlugin) // theoretically we shouldn't need this because of bevy_sk, but everything is tangled in // there and idk what we actually need to run .add(PbrPlugin { // this seems to only apply to StandardMaterial, we don't use that prepass_enabled: true, add_default_deferred_lighting_plugin: false, use_gpu_instance_buffer_builder: true, debug_flags: RenderDebugFlags::default(), }) // required for gltf .add(ScenePlugin) .add(GltfPlugin::default()) .add(AudioPlugin::default()) .add(GizmoPlugin); let mut task_pool_plugin = TaskPoolPlugin::default(); // make tokio work let handle = tokio::runtime::Handle::current(); let enter_runtime_context = Arc::new(move || { // TODO: this might be a memory leak std::mem::forget(handle.enter()); }); task_pool_plugin.task_pool_options.io.on_thread_spawn = Some(enter_runtime_context.clone()); task_pool_plugin.task_pool_options.compute.on_thread_spawn = Some(enter_runtime_context.clone()); task_pool_plugin .task_pool_options .async_compute .on_thread_spawn = Some(enter_runtime_context.clone()); plugins = plugins.set(task_pool_plugin); app.add_plugins( add_xr_plugins(plugins.add(WindowPlugin::default())) .set(OxrInitPlugin { app_info: AppInfo { name: "Stardust XR".into(), version: bevy_mod_openxr::types::Version(0, 44, 1), }, exts: { // all OpenXR extensions can be requested here let mut exts = OxrExtensions::default(); exts.enable_hand_tracking(); if args.overlay_priority.is_some() { exts.enable_extx_overlay(); } exts }, ..default() }) .set(OxrRenderPlugin { default_wait_frame: false, ..default() }) .set(OxrReferenceSpacePlugin { default_primary_ref_space: ReferenceSpaceType::LOCAL, }) // Disable a bunch of unneeded plugins // this plugin uses the fb extention, blend mode still works .disable::() // we don't do any action stuff that needs to integrate with the ecosystem .disable::() .disable::(), ); app.add_plugins(( bevy_sk::hand::HandPlugin, bevy_sk::vr_materials::SkMaterialPlugin { replace_standard_material: true, }, bevy_sk::skytext::SphericalHarmonicsPlugin, )); app.add_plugins(HandGizmosPlugin); // app.add_plugins(MeshTextPlugin); app.init_asset::().init_asset_loader::(); if let Some(priority) = args.overlay_priority { app.insert_resource(OxrOverlaySettings { session_layer_placement: priority, ..default() }); } app.insert_resource(OxrSessionConfig { blend_modes: Some(vec![ EnvironmentBlendMode::ALPHA_BLEND, EnvironmentBlendMode::ADDITIVE, EnvironmentBlendMode::OPAQUE, ]), ..default() }); let mut pre_frame_wait = Schedule::new(PreFrameWait); pre_frame_wait.set_executor_kind(ExecutorKind::MultiThreaded); app.add_schedule(pre_frame_wait); app.insert_resource(ClearColor(Color::BLACK.with_alpha(0.0))); app.insert_resource(ObjectRegistryRes(object_registry)); app.add_plugins((RemotePlugin::default(), RemoteHttpPlugin::default())); // the Stardust server plugins // infra plugins app.add_plugins(EntityHandlePlugin); // node plugins app.add_plugins(( SpatialNodePlugin, ModelNodePlugin, TextNodePlugin, LinesNodePlugin, )); // object plugins app.add_plugins((PlaySpacePlugin, HandPlugin, ControllerPlugin)); app.add_systems(PostStartup, move || { ready_notifier.notify_waiters(); }); app.add_systems(Update, update_cameras); app.add_systems( XrFirst, xr_step .in_set(OxrWaitFrameSystem) .in_set(XrHandleEvents::FrameLoop), ); app.run(); } fn update_cameras(mut camera: Query<&mut Projection, (With,)>) { for mut projection in &mut camera { match projection.deref_mut() { Projection::Perspective(perspective_projection) => perspective_projection.near = 0.003, Projection::Orthographic(orthographic_projection) => { orthographic_projection.near = 0.003 } Projection::Custom(custom_projection) => { if let Some(xr) = custom_projection.get_mut::() { xr.near = 0.003 } else { error_once!("unknown custom camera projection"); } } } } } fn xr_step(world: &mut World) { // camera::update(token); #[cfg(feature = "wayland")] wayland.frame_event(); destroy_queue::clear(); // update things like the Xr input methods world.run_schedule(PreFrameWait); input::process_input(); let time = world.resource::().delta_secs_f64(); nodes::root::Root::send_frame_events(time); // we are targeting the frame after the wait if let Some(mut state) = world.get_resource_mut::() { state.predicted_display_time = openxr::Time::from_nanos( state.predicted_display_time.as_nanos() + state.predicted_display_period.as_nanos(), ); } let should_wait = world .run_system_cached(should_run_frame_loop) .unwrap_or(false); if should_wait { world.resource_scope::(|world, mut waiter| { let state = waiter .wait() .inspect_err(|err| error!("failed to wait OpenXR frame: {err}")) .ok(); if let Some(state) = state { world.insert_resource(OxrFrameState(state)); } }); } tick_internal_client(); #[cfg(feature = "wayland")] wayland.update(); // drawable::draw(token); // audio::update(); } fn stereokit_loop( sk_ready_notifier: Arc, project_dirs: Option, args: CliArgs, dbus_connection: Connection, object_registry: ObjectRegistry, ) { let sk = SkSettings::default() .app_name("Stardust XR") .blend_preference(DisplayBlend::AnyTransparent) .mode(if args.flatscreen { AppMode::Simulator } else { AppMode::XR }) .depth_mode(DepthMode::D32) .log_filter(match EnvFilter::from_default_env().max_level_hint() { Some(LevelFilter::ERROR) => LogLevel::Error, Some(LevelFilter::WARN) => LogLevel::Warning, Some(LevelFilter::INFO) => LogLevel::Inform, Some(LevelFilter::DEBUG) => LogLevel::Diagnostic, Some(LevelFilter::TRACE) => LogLevel::Diagnostic, Some(LevelFilter::OFF) => LogLevel::None, None => LogLevel::Warning, }) .overlay_app(args.overlay_priority.is_some()) .overlay_priority(args.overlay_priority.unwrap_or(u32::MAX)) .disable_desktop_input_window(true) .origin(OriginMode::Local) .init() .expect("StereoKit failed to initialize"); info!("Init StereoKit"); Renderer::multisample(0); Material::default().shader(Shader::pbr_clip()); Ui::enable_far_interact(false); let left_hand_material = Material::find("default/material_hand").unwrap(); let mut right_hand_material = left_hand_material.copy(); right_hand_material.id("right_hand"); Input::hand_material(Handed::Right, Some(Material::find("right_hand").unwrap())); Input::hand_visible(Handed::Left, false); Input::hand_visible(Handed::Right, false); // Skytex/light stuff { let _ = DEFAULT_SKYTEX.set(Tex::gen_color( Color128::BLACK, 1, 1, TexType::Cubemap, TexFormat::RGBA32, )); let _ = DEFAULT_SKYLIGHT.set(Renderer::get_skylight()); if let Some(sky) = project_dirs .as_ref() .map(|dirs| dirs.config_dir().join("skytex.hdr")) .filter(|f| f.exists()) .and_then(|p| SHCubemap::from_cubemap(p, true, 100).ok()) { sky.render_as_sky(); } else { Renderer::skytex(DEFAULT_SKYTEX.get().unwrap()); } } #[cfg(feature = "wayland")] let mut wayland = wayland::Wayland::new().expect("Could not initialize wayland"); #[cfg(feature = "wayland")] wayland.make_context_current(); sk_ready_notifier.notify_waiters(); info!("Stardust ready!"); let mut objects = ServerObjects::new( dbus_connection.clone(), &sk, [left_hand_material, right_hand_material], args.disable_controllers, args.disable_hands, ); let mut last_frame_delta = Duration::ZERO; let mut sleep_duration = Duration::ZERO; while let Some(token) = sk.step() { let _span = debug_span!("StereoKit step"); let _span = _span.enter(); camera::update(token); #[cfg(feature = "wayland")] wayland.frame_event(); destroy_queue::clear(); objects.update(&sk, token, &dbus_connection, &object_registry); input::process_input(); nodes::root::Root::send_frame_events(Time::get_step_unscaled()); adaptive_sleep( &mut last_frame_delta, &mut sleep_duration, Duration::from_micros(250), ); tick_internal_client(); #[cfg(feature = "wayland")] wayland.update(); drawable::draw(token); audio::update(); } info!("Cleanly shut down StereoKit"); } fn adaptive_sleep( last_frame_delta: &mut Duration, sleep_duration: &mut Duration, sleep_duration_increase: Duration, ) { let frame_delta = Duration::from_secs_f64(Time::get_step_unscaled()); if *last_frame_delta < frame_delta { if let Some(frame_delta_delta) = frame_delta.checked_sub(*last_frame_delta) { if let Some(new_sleep_duration) = sleep_duration.checked_sub(frame_delta_delta) { *sleep_duration = new_sleep_duration; } } } else { *sleep_duration += sleep_duration_increase; } debug_span!("Sleep", ?sleep_duration, ?frame_delta, ?last_frame_delta).in_scope(|| { *last_frame_delta = frame_delta; std::thread::sleep(*sleep_duration); // to give clients a chance to even update anything before drawing }); }