Merge pull request #133 from Schmarni-Dev/final_touches

add READMEs

Cargo.lock

@@ -787,15 +787,6 @@ dependencies = [
  "bevy",
 ]
 
-[[package]]
-name = "bevy_mod_xr_backends"
-version = "0.1.0-rc1"
-dependencies = [
- "bevy",
- "bevy_mod_openxr",
- "bevy_mod_xr",
-]
-
 [[package]]
 name = "bevy_openxr_android"
 version = "0.1.0-rc1"
@@ -1646,7 +1637,7 @@ version = "0.5.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "330c60081dcc4c72131f8eb70510f1ac07223e5d4163db481a04a0befcffa412"
 dependencies = [
- "libloading 0.8.4",
+ "libloading 0.7.4",
 ]
 
 [[package]]
@@ -1919,7 +1910,7 @@ dependencies = [
  "vec_map",
  "wasm-bindgen",
  "web-sys",
- "windows 0.57.0",
+ "windows 0.52.0",
 ]
 
 [[package]]
@@ -4122,18 +4113,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9252e5725dbed82865af151df558e754e4a3c2c30818359eb17465f1346a1b49"
 dependencies = [
  "windows-core 0.54.0",
- "windows-implement 0.53.0",
- "windows-interface 0.53.0",
- "windows-targets 0.52.6",
-]
-
-[[package]]
-name = "windows"
-version = "0.57.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "12342cb4d8e3b046f3d80effd474a7a02447231330ef77d71daa6fbc40681143"
-dependencies = [
- "windows-core 0.57.0",
+ "windows-implement",
+ "windows-interface",
  "windows-targets 0.52.6",
 ]
 
@@ -4156,18 +4137,6 @@ dependencies = [
  "windows-targets 0.52.6",
 ]
 
-[[package]]
-name = "windows-core"
-version = "0.57.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d2ed2439a290666cd67ecce2b0ffaad89c2a56b976b736e6ece670297897832d"
-dependencies = [
- "windows-implement 0.57.0",
- "windows-interface 0.57.0",
- "windows-result",
- "windows-targets 0.52.6",
-]
-
 [[package]]
 name = "windows-implement"
 version = "0.53.0"
@@ -4179,17 +4148,6 @@ dependencies = [
  "syn 2.0.68",
 ]
 
-[[package]]
-name = "windows-implement"
-version = "0.57.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9107ddc059d5b6fbfbffdfa7a7fe3e22a226def0b2608f72e9d552763d3e1ad7"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn 2.0.68",
-]
-
 [[package]]
 name = "windows-interface"
 version = "0.53.0"
@@ -4201,17 +4159,6 @@ dependencies = [
  "syn 2.0.68",
 ]
 
-[[package]]
-name = "windows-interface"
-version = "0.57.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "29bee4b38ea3cde66011baa44dba677c432a78593e202392d1e9070cf2a7fca7"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn 2.0.68",
-]
-
 [[package]]
 name = "windows-result"
 version = "0.1.2"

Cargo.toml

@@ -1,11 +1,3 @@
-[package]
-name = "bevy_mod_xr_backends"
-version.workspace = true
-edition.workspace = true
-description.workspace = true
-repository.workspace = true
-license.workspace = true
-
 [workspace.package]
 version = "0.1.0-rc1"
 edition = "2021"
@@ -13,13 +5,14 @@ description = "Community crate for XR in Bevy"
 repository = "https://github.com/awtterpip/bevy_oxr"
 license = "MIT/Apache-2.0"
 
-[dependencies]
-bevy_mod_openxr.path = "./crates/bevy_openxr"
-bevy_mod_xr.path = "./crates/bevy_xr"
-bevy.workspace = true
-
 [workspace]
+resolver = "2"
 members = ["crates/*", "crates/bevy_openxr/examples/android"]
 
 [workspace.dependencies]
-bevy = "0.14.0"
+bevy = { version = "0.14.0", default-features = false, features = [
+	"bevy_render",
+	"bevy_core_pipeline",
+	"bevy_winit",
+	"x11",
+] }

crates/bevy_openxr/Cargo.toml

@@ -1,7 +1,11 @@
 [package]
 name = "bevy_mod_openxr"
+description = "Community crate for OpenXR in Bevy"
 version.workspace = true
 edition.workspace = true
+repository.workspace = true
+license.workspace = true
+keywords = ["gamedev", "bevy", "Xr", "Vr", "OpenXR"]
 
 [features]
 default = ["vulkan", "d3d12", "passthrough"]
@@ -11,6 +15,7 @@ passthrough = []
 
 [dev-dependencies]
 bevy_xr_utils.path = "../bevy_xr_utils"
+bevy = { workspace = true, default-features = true }
 
 [target.'cfg(target_os = "android")'.dependencies]
 ndk-context = "0.1"
@@ -26,7 +31,7 @@ openxr = "0.18.0"
 thiserror = "1.0.57"
 wgpu = "0.20"
 wgpu-hal = "0.21"
-bevy_mod_xr={path = "../bevy_xr",version = "0.1.0-rc1"}
+bevy_mod_xr = { path = "../bevy_xr", version = "0.1.0-rc1" }
 
 ash = { version = "0.37.3", optional = true }
 

crates/bevy_openxr/README.md

@@ -0,0 +1,6 @@
+# Bevy mod OpenXR
+
+This is the OpenXR backend for bevy_mod_xr for more info see the [repo](https://github.com/awtterpip/bevy_oxr)
+
+![](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExY2FlOXJrOG1pbzFkYTVjZHIybndqamF1a2YwZHU3dXgyZGcwdmFzMiZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/CHbQyXOT5yZZ1VQRh7/giphy-downsized-large.gif)
+![](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExbHVmZXc2b3VhcGE2eHE2c2Y3NDR6cXNibHdjNjk5MmtyOHlkMXkwZyZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/Hsvp5el2o7tzgOf9GQ/giphy-downsized-large.gif)

crates/bevy_webxr/README.md

@@ -1,2 +1,3 @@
 # Bevy WebXR
+
 currently not yet in a working state

crates/bevy_xr/Cargo.toml

@@ -1,7 +1,11 @@
 [package]
 name = "bevy_mod_xr"
+description = "semi generic Xr Api for Community Driven XR in Bevy"
 version.workspace = true
 edition.workspace = true
+license.workspace = true
+repository.workspace = true
+keywords = ["gamedev", "bevy", "Xr", "Vr"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

crates/bevy_xr/README.md

@@ -0,0 +1,3 @@
+# Bevy Mod XR
+
+the shared api crate for bevy_mod_xr for more info see the [repo](https://github.com/awtterpip/bevy_oxr)

crates/bevy_xr_utils/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-bevy.workspace = true
+bevy = { workspace = true, features = ["bevy_gizmos"] }
 bevy_mod_xr = { path = "../bevy_xr", version = "0.1.0-rc1" }
 bevy_mod_openxr = { path = "../bevy_openxr", version = "0.1.0-rc1" }
 

crates/bevy_xr_utils/README.md

@@ -0,0 +1,3 @@
+# Bevy XR Utils
+
+some optinal utils built on bevy_mod_xr and it's openxr backend

src/lib.rs

@@ -1,2 +0,0 @@
-pub use bevy_mod_openxr;
-pub use bevy_mod_xr;