Tue Mar 18 07:18:34 PM EDT 2025

.cargo/config.toml

@@ -0,0 +1,2 @@
+[profile.dev.package."*"]
+opt-level = 2

.gitea/workflows/build.yaml

@@ -0,0 +1,25 @@
+name: Build
+on: [push]
+
+jobs:
+  Build:
+    env:
+      RUNNER_TOOL_CACHE: /toolcache
+    container: rust:alpine
+    steps:
+      - name: Install node
+        run: apk add nodejs gcc libc-dev pkgconf libx11-dev alsa-lib-dev eudev-dev tar openssl-dev
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Restore cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Build
+        run: cargo build --release

.github/workflows/docs.yml

@@ -1,50 +0,0 @@
-name: Docs
-on:
-  push:
-    branches: [master]
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-concurrency:
-  group: deploy
-  cancel-in-progress: false
-jobs:
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Install Dependencies
-        run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
-      - name: Setup Rust
-        uses: dtolnay/rust-toolchain@stable
-      - name: Configure cache
-        uses: Swatinem/rust-cache@v2
-      - name: Setup pages
-        id: pages
-        uses: actions/configure-pages@v4
-      - name: Clean docs folder
-        run: cargo clean --doc
-      - name: Build docs
-        run: cargo doc --no-deps
-      - name: Add redirect
-        run: echo '<meta http-equiv="refresh" content="0;url=bevy_dirworld/index.html">' > target/doc/index.html
-      - name: Remove lock file
-        run: rm target/doc/.lock
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: target/doc
-  deploy:
-    name: Deploy
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4

.github/workflows/rust.yml

@@ -1,24 +0,0 @@
-name: Rust
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-env:
-  CARGO_TERM_COLOR: always
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Install Dependencies
-      run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bevy_dirworld"
-version = "0.4.0"
+version = "0.4.1"
 edition = "2021"
 
 [dependencies]
@@ -16,7 +16,7 @@ notify-debouncer-full = "0.5"
 md5 = "0.7"
 aes = "0.8"
 hex = "0.4"
-hex-literal = "0.4"
+hex-literal = "1.0"
 uuid = "1.11"
 lazy_static = "1.5"
 
@@ -30,7 +30,7 @@ version = "0.2"
 features = ["serialize"]
 
 [dependencies.occule]
-git = "https://git.soaos.dev/occule"
+git = "https://git.soaos.dev/soaos/occule"
 tag = "v0.3.1"
 
 [dependencies.yarnspinner]
@@ -43,7 +43,7 @@ version = "0.9"
 features = ["lua54", "bevy_bindings"]
 
 [dependencies.bevy_basic_interaction]
-git = "https://git.soaos.dev/bevy_basic_interaction"
+git = "https://git.soaos.dev/soaos/bevy_basic_interaction"
 tag = "v0.2.0"
 
 [dependencies.strum]

src/events.rs

@@ -6,10 +6,12 @@ use bevy::prelude::*;
 #[derive(Debug, Event, Deref, DerefMut, Clone)]
 pub struct DirworldLeaveRoom(pub PathBuf);
 
-/// Event called when entering a room
+/// Event called when entering a room, but before loading and spawning entities.
 #[derive(Debug, Event, Clone)]
 pub struct DirworldEnterRoom {
+    /// Room entered
     pub exited: PathBuf,
+    /// Room exited from
     pub entered: PathBuf,
 }
 
@@ -17,9 +19,12 @@ pub struct DirworldEnterRoom {
 #[derive(Debug, Event, Deref, DerefMut, Clone)]
 pub struct DirworldChangeRoot(pub PathBuf);
 
+/// Event called once navigation between rooms is complete (all entities loaded and spawned).
 #[derive(Debug, Event, Clone)]
 pub struct DirworldNavigationComplete {
+    /// Room entered
     pub from: PathBuf,
+    /// Room exited
     pub to: PathBuf,
 }
 

src/lib.rs

@@ -6,16 +6,18 @@ use std::{ffi::OsStr, path::PathBuf};
 
 use actor::ActorPlugin;
 use bevy::{ecs::system::IntoObserverSystem, prelude::*};
-use bevy_mod_scripting::core::ScriptingPlugin;
 use bevy_mod_scripting::lua::LuaScriptingPlugin;
 use cache::DirworldCache;
-use events::{DirworldChangeRoot, DirworldEnterRoom, DirworldLeaveRoom, DirworldNavigationComplete, DirworldSpawn};
+use events::{
+    DirworldChangeRoot, DirworldEnterRoom, DirworldLeaveRoom, DirworldNavigationComplete,
+    DirworldSpawn,
+};
 use occule::Codec;
 use preload::{DirworldPreload, DirworldPreloadPlugin};
-use resources::{DirworldLastDir, EntryType};
 use resources::{
     DirworldCodecs, DirworldCurrentDir, DirworldObservers, DirworldRootDir, DirworldTasks,
 };
+use resources::{DirworldLastDir, EntryType};
 pub use watcher::DirworldWatcherEvent;
 pub use watcher::DirworldWatcherSet;
 

src/lua_api.rs

@@ -1,3 +1,6 @@
+// TODO: remove
+#![allow(dead_code)]
+
 use std::str::FromStr;
 
 use bevy::prelude::*;
@@ -50,7 +53,8 @@ pub fn register(world: &mut World) {
 
 fn translate(ctx: FunctionCallContext, entity: Val<Entity>, translation: Val<Vec3>) {
     let world = ctx.world().unwrap();
-    world.with_global_access(|world| {
+    // TODO: Handle
+    let _ = world.with_global_access(|world| {
         if let Some(mut transform) = world.entity_mut(*entity).get_mut::<Transform>() {
             transform.translation += *translation;
         }
@@ -59,7 +63,7 @@ fn translate(ctx: FunctionCallContext, entity: Val<Entity>, translation: Val<Vec
 
 fn rotate(ctx: FunctionCallContext, entity: Val<Entity>, axis: Val<Vec3>, angle: f32) {
     let world = ctx.world().unwrap();
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         if let Some(mut transform) = world.entity_mut(*entity).get_mut::<Transform>() {
             transform.rotation *= Quat::from_axis_angle(*axis, angle);
         }
@@ -69,7 +73,7 @@ fn rotate(ctx: FunctionCallContext, entity: Val<Entity>, axis: Val<Vec3>, angle:
 fn get_dirworld_id(ctx: FunctionCallContext, entity: Val<Entity>) -> Result<String, InteropError> {
     let world = ctx.world()?;
     let mut result = Ok(Default::default());
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         result = if let Some(dirworld_entity) = world.entity(*entity).get::<DirworldEntity>() {
             Ok(dirworld_entity
                 .payload
@@ -88,7 +92,7 @@ fn get_dirworld_id(ctx: FunctionCallContext, entity: Val<Entity>) -> Result<Stri
 fn condition_true(ctx: FunctionCallContext) -> Result<bool, InteropError> {
     let world = ctx.world()?;
     let mut result = Ok(Default::default());
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         result = Ok(Condition::True.evaluate(world));
     });
     result
@@ -109,7 +113,7 @@ fn condition_ancestor_of(
     };
     let world = ctx.world()?;
     let mut result = Ok(Default::default());
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         result = Ok(Condition::AncestorOf {
             ancestor,
             descendant,
@@ -134,7 +138,7 @@ fn condition_descendant_of(
     };
     let world = ctx.world()?;
     let mut result = Ok(Default::default());
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         result = Ok(Condition::DescendantOf {
             ancestor,
             descendant,
@@ -159,7 +163,7 @@ fn condition_parent_of(
     };
     let world = ctx.world()?;
     let mut result = Ok(Default::default());
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         result = Ok(Condition::ParentOf { parent, child }.evaluate(world));
     });
     result
@@ -180,7 +184,7 @@ fn condition_child_of(
     };
     let world = ctx.world()?;
     let mut result = Ok(Default::default());
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         result = Ok(Condition::ChildOf { parent, child }.evaluate(world));
     });
     result
@@ -196,7 +200,7 @@ fn condition_in_room(
     };
     let world = ctx.world()?;
     let mut result = Ok(Default::default());
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         result = Ok(Condition::InRoom(room).evaluate(world));
     });
     result
@@ -212,7 +216,7 @@ fn condition_object_in_room(
     };
     let world = ctx.world()?;
     let mut result = Ok(Default::default());
-    world.with_global_access(|world| {
+    let _ = world.with_global_access(|world| {
         result = Ok(Condition::ObjectInRoom(object).evaluate(world));
     });
     result

src/observers.rs

@@ -1,5 +1,6 @@
 use std::ops::Deref;
 
+use avian3d::prelude::{Physics, PhysicsTime};
 use bevy::prelude::*;
 use notify::{
     event::{MetadataKind, ModifyKind, RenameMode},
@@ -10,7 +11,7 @@ use crate::{
     cache::DirworldCache,
     components::{DirworldEntity, Persist},
     events::{
-        DirworldChangeRoot, DirworldEnterRoom, DirworldLeaveRoom, DirworldNavigationComplete,
+        DirworldChangeRoot, DirworldEnterRoom, DirworldLeaveRoom,
     },
     preload::{load_entity, DirworldPreloadBegin, PreloadState, RoomAssets},
     resources::{
@@ -48,7 +49,11 @@ pub fn navigate_to_room(
     mut next_preload_state: ResMut<NextState<PreloadState>>,
     mut room_assets: ResMut<RoomAssets>,
     mut dirworld_tasks: ResMut<DirworldTasks>,
+    persitent_entities: Query<&DirworldEntity, With<Persist>>,
+    mut time: ResMut<Time<Physics>>,
 ) {
+    time.pause();
+    dirworld_tasks.insert("Loading Room".into(), None);
     let DirworldEnterRoom {
         exited: old_path,
         entered: path,
@@ -89,7 +94,6 @@ pub fn navigate_to_room(
         }
     };
 
-    dirworld_tasks.insert("Loading Room".into(), None);
     for entry in entries {
         load_entity(
             &entry,
@@ -99,6 +103,8 @@ pub fn navigate_to_room(
             &mut commands,
             &mut next_preload_state,
             &mut room_assets,
+            &root_dir,
+            &persitent_entities,
         );
     }
     preload_event_writer.send(DirworldPreloadBegin { old_path: old_path.clone(), path: path.clone() });
@@ -115,6 +121,8 @@ pub fn handle_changes(
     mut event_writer: EventWriter<DirworldWatcherEvent>,
     mut next_preload_state: ResMut<NextState<PreloadState>>,
     mut room_assets: ResMut<RoomAssets>,
+    persitent_entities: Query<&DirworldEntity, With<Persist>>,
+    root_dir: Res<DirworldRootDir>,
 ) {
     let event = &trigger.event().0;
     info!("Watcher Event: {event:?}");
@@ -134,6 +142,8 @@ pub fn handle_changes(
                     &mut commands,
                     &mut next_preload_state,
                     &mut room_assets,
+                    &root_dir,
+                    &persitent_entities,
                 );
             }
         }
@@ -147,6 +157,8 @@ pub fn handle_changes(
                 &mut commands,
                 &mut next_preload_state,
                 &mut room_assets,
+                &root_dir,
+                &persitent_entities,
             );
         }
         EventKind::Modify(ModifyKind::Metadata(MetadataKind::Any)) => {
@@ -159,6 +171,8 @@ pub fn handle_changes(
                 &mut commands,
                 &mut next_preload_state,
                 &mut room_assets,
+                &root_dir,
+                &persitent_entities,
             );
         }
         _ => {

src/preload/events.rs

@@ -12,8 +12,11 @@ pub struct DirworldPreload {
     pub data: Option<Vec<u8>>,
 }
 
+/// Event triggered once preloading begins in a room
 #[derive(Debug, Event, Clone)]
 pub struct DirworldPreloadBegin {
+    /// Path of old room
     pub old_path: PathBuf,
+    /// Path of loading room
     pub path: PathBuf,
 }

src/preload/mod.rs

@@ -1,4 +1,6 @@
 use crate::cache::DirworldCache;
+use crate::components::Persist;
+use crate::resources::DirworldRootDir;
 use crate::{
     components::DirworldEntity,
     resources::{DirworldCodecs, DirworldObservers, EntryType},
@@ -6,6 +8,7 @@ use crate::{
     Extensions,
 };
 use bevy::prelude::*;
+use std::path::Path;
 use std::{collections::HashMap, path::PathBuf};
 
 mod systems;
@@ -13,6 +16,7 @@ mod systems;
 mod resources;
 pub use resources::*;
 
+/// Preload-related events
 pub mod events;
 pub use events::*;
 
@@ -59,8 +63,18 @@ pub fn load_entity(
     commands: &mut Commands,
     preload_state: &mut NextState<PreloadState>,
     room_assets: &mut RoomAssets,
+    root_dir: &DirworldRootDir,
+    persistent_entities: &Query<&DirworldEntity, With<Persist>>,
 ) {
     info!("Entity: {entry:?}");
+    if persistent_entities.iter().find(|e| e.path == *entry).is_some() {
+        info!("Entity is persistent, skipping...");
+        return;
+    }
+    if Some(entry.canonicalize().unwrap()) == root_dir.0.as_ref().and_then(|d| d.parent().map(Path::to_path_buf)) {
+        info!("Entity is root directory, skipping...");
+        return;
+    }
     let (mut payload, data) = extract_entity_payload(&entry, &codecs);
     payload = payload.map(|p| cache.get_entity_cache(&entry).unwrap_or(p));
     let entry_type = if entry.is_dir() {

src/preload/resources.rs

@@ -6,8 +6,11 @@ use bevy::prelude::*;
 #[derive(Resource, Default, Debug, Deref, DerefMut)]
 pub struct RoomAssets(pub HashMap<PathBuf, HashMap<String, UntypedHandle>>);
 
+/// Paths used while preloading entities
 #[derive(Resource, Clone)]
 pub struct PreloadPaths {
+    /// Path of old room
     pub src: PathBuf,
+    /// Path of current room
     pub dst: PathBuf,
 }

src/preload/systems.rs

@@ -1,7 +1,8 @@
+use avian3d::prelude::{Physics, PhysicsTime};
 use bevy::prelude::*;
 
 use crate::{
-    components::DirworldEntity,
+    components::{DirworldEntity, Persist},
     events::{DirworldNavigationComplete, DirworldSpawn},
     resources::{DirworldObservers, DirworldTasks, EntryType},
     Extensions,
@@ -41,10 +42,11 @@ pub fn handle_preload(
 
 pub fn handle_spawn(
     preload_paths: Res<PreloadPaths>,
-    dirworld_entity_query: Query<(Entity, &DirworldEntity)>,
+    dirworld_entity_query: Query<(Entity, &DirworldEntity), Without<Persist>>,
     mut commands: Commands,
     observers: Res<DirworldObservers>,
     mut event_writer: EventWriter<DirworldNavigationComplete>,
+    mut time: ResMut<Time<Physics>>,
 ) {
     info!("Spawning");
     for (entity, DirworldEntity { path, .. }) in dirworld_entity_query.iter() {
@@ -58,6 +60,7 @@ pub fn handle_spawn(
             commands.trigger_targets(DirworldSpawn(entity), observer.clone());
         }
     }
+    time.unpause();
     event_writer.send(DirworldNavigationComplete {
         from: preload_paths.src.clone(),
         to: preload_paths.dst.clone(),

src/resources.rs

@@ -19,6 +19,7 @@ pub struct DirworldCurrentDir {
     pub payload: Option<DirworldEntityPayload>,
 }
 
+/// Last room player was in
 #[derive(Resource, Deref, DerefMut, Default, Debug)]
 pub struct DirworldLastDir(pub PathBuf);