[ { "path": ".cargo/config.toml", "content": "[alias]\nexample2d = \"run --example example2d --features _example2d_full\"\nexample3d = \"run --example example3d --features _example3d_full\"\ncustom_camera3d = \"run --example custom_camera3d --features _example3d_full\"\ndoors_to_other_levels = \"run --example doors_to_other_levels --features _doors_to_other_levels_full\"\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\r\non:\r\n pull_request:\r\n push:\r\n branches: [main]\r\n\r\n# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages\r\npermissions:\r\n contents: read\r\n pages: write\r\n id-token: write\r\n checks: write\r\n\r\njobs:\r\n ci:\r\n name: CI\r\n needs: [test, clippy, docs]\r\n runs-on: ubuntu-latest\r\n steps:\r\n - name: Done\r\n run: exit 0\r\n test:\r\n name: Tests\r\n strategy:\r\n fail-fast: false\r\n matrix:\r\n os: [ubuntu-latest]\r\n rust: [1.92.0, nightly]\r\n runs-on: ${{ matrix.os }}\r\n steps:\r\n - uses: actions/checkout@v3\r\n - name: Install rust\r\n uses: dtolnay/rust-toolchain@master\r\n with:\r\n toolchain: ${{ matrix.rust }}\r\n - name: Ready cache\r\n if: matrix.os == 'ubuntu-latest'\r\n run: sudo chown -R $(whoami):$(id -ng) ~/.cargo/\r\n - name: Install dependencies\r\n run: sudo apt-get update; sudo apt-get install --no-install-recommends libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libudev-dev\r\n - name: Cache cargo\r\n uses: actions/cache@v4\r\n id: cache\r\n with:\r\n path: ~/.cargo\r\n key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}\r\n - name: Test\r\n run: cargo test --verbose --all-features --features bevy/bevy_gltf -- --nocapture\r\n fmt:\r\n name: Rustfmt\r\n runs-on: ubuntu-latest\r\n steps:\r\n - uses: actions/checkout@v3\r\n - uses: dtolnay/rust-toolchain@master\r\n with:\r\n toolchain: 1.92.0\r\n components: rustfmt\r\n - name: Run fmt --all -- --check\r\n run: cargo fmt --all -- --check\r\n\r\n clippy:\r\n name: Clippy\r\n runs-on: ubuntu-latest\r\n steps:\r\n - uses: actions/checkout@v3\r\n - uses: dtolnay/rust-toolchain@master\r\n with:\r\n toolchain: 1.92.0\r\n components: clippy\r\n - name: Install dependencies\r\n run: sudo apt-get update; sudo apt-get install --no-install-recommends libudev-dev\r\n - name: Cache cargo\r\n uses: actions/cache@v4\r\n id: cache\r\n with:\r\n path: ~/.cargo\r\n key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}\r\n - name: Run clippy --all-targets --\r\n uses: actions-rs/clippy-check@v1\r\n with:\r\n token: ${{ secrets.GITHUB_TOKEN }}\r\n args: --all-targets --\r\n docs:\r\n name: Docs\r\n runs-on: ubuntu-latest\r\n steps:\r\n - uses: actions/checkout@v3\r\n - uses: dtolnay/rust-toolchain@master\r\n with:\r\n toolchain: 1.92.0\r\n - name: Install dependencies\r\n run: sudo apt-get update; sudo apt-get install --no-install-recommends libudev-dev\r\n - name: Cache cargo\r\n uses: actions/cache@v4\r\n id: cache\r\n with:\r\n path: ~/.cargo\r\n key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}\r\n - name: Run doc tests\r\n run: cargo test --doc --all-features --features bevy/bevy_gltf\r\n - name: Check docs\r\n run: cargo doc --no-deps --all-features --features bevy/x11\r\n docs-and-demos-ghpages:\r\n name: Update Docs and Demos in GitHub Pages\r\n runs-on: ubuntu-latest\r\n if: github.ref == 'refs/heads/main'\r\n steps:\r\n - uses: actions/checkout@v3\r\n - uses: jetli/wasm-bindgen-action@v0.2.0\r\n with:\r\n version: 'latest'\r\n - uses: dtolnay/rust-toolchain@master\r\n with:\r\n targets: wasm32-unknown-unknown\r\n toolchain: 1.92.0\r\n - name: Build docs\r\n env:\r\n GITHUB_REPO: ${{ github.repository }}\r\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\r\n run: |-\r\n cargo doc --no-deps --verbose --all-features --features bevy/webgl2,bevy/x11 &&\r\n echo \"\" > target/doc/index.html\r\n required_features=$(\r\n (\r\n cargo metadata --no-deps --format-version 1 \\\r\n | jq '.packages[].targets[] | select(.kind == [\"example\"]) | .[\"required-features\"][]' -r\r\n echo bevy/webgl2\r\n echo bevy/x11\r\n ) | tr '\\n' ' '\r\n )\r\n RUSTFLAGS='--cfg getrandom_backend=\"wasm_js\"' cargo build --examples --release --features \"$required_features\" --target wasm32-unknown-unknown\r\n for demowasm in $(cd target/wasm32-unknown-unknown/release/examples; ls *.wasm | grep -v -); do\r\n wasm-bindgen target/wasm32-unknown-unknown/release/examples/$demowasm --out-dir target/doc/demos/ --target web\r\n cat > target/doc/demos/${demowasm%.*}.html <\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n EOF\r\n done\r\n cp -R assets/ target/doc/demos/\r\n - name: Add read permissions\r\n run: |-\r\n chmod --recursive +r target/doc\r\n - name: Upload artifact\r\n uses: actions/upload-pages-artifact@v3\r\n with:\r\n path: target/doc\r\n deploy-ghpages:\r\n environment:\r\n name: github-pages\r\n url: ${{ steps.deployment.outputs.page_url }}\r\n runs-on: ubuntu-latest\r\n needs: docs-and-demos-ghpages\r\n if: github.ref == 'refs/heads/main'\r\n steps:\r\n - name: Deploy to GitHub Pages\r\n id: deployment\r\n uses: actions/deploy-pages@v4\r\n" }, { "path": ".gitignore", "content": "/target\nCargo.lock\n\nassets/levels2d/*.yol\nassets/levels2d/*.yoli\n!assets/levels2d/example.yol\n\nassets/levels3d/*.yol\nassets/levels3d/*.yoli\n!assets/levels3d/example.yol\n\n#IDES\n/.vscode\n\n# No ignored level files in levels_doors\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)\nand this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).\n\n## [Unreleased]\n\n## 0.31.0 - 2026-01-15\n### Changed\n- Upgrade Bevy to 0.18\n\n## 0.30.0 - 2026-01-15\n### Added\n- Automatic UI generation for components using reflection and attributes.\n - Supported numeric, boolean, string, vector, color, enum, option, list,\n asset, and entity fields.\n- `YoleckEntityRef` type with automatic UI, filtering, and runtime UUID\n resolution.\n - Drag and drop support for entity references: entities with UUID can now be\n dragged from the entity list and dropped onto `YoleckEntityRef` fields in\n the properties panel.\n - Entity type filtering is automatically applied when dropping entities onto\n entity reference fields with type constraints.\n- `console_layer_factory` for routing Bevy logs into the Yoleck console.\n- `YoleckConsoleLogHistory` for storing up to 1000 recent log entries.\n- `YoleckConsoleState` for managing console UI state.\n- `YoleckEditorBottomPanelSections` for extensible bottom-panel tabs.\n- `Vpeol3dCameraMode` enum with variants: `Fps`, `Sidescroller`, `Topdown`,\n `Custom(u32)`.\n- `YoleckCameraChoices` resource for customizing available camera modes in 3D\n editor.\n- Support for custom camera modes with user-defined movement logic.\n - Camera mode selector dropdown in editor top panel for switching between\n camera modes.\n - `Vpeol3dCameraControl::fps()` preset for FPS-style camera with full\n rotation freedom.\n- Scene gizmo for camera orientation.\n- Translation gizmo for `vpeol_3d`.\n - For all 3 world axes (X, Y, Z) by default.\n - World/Local mode toggle for the translation gizmo in 3D editor top panel.\n- Keyboard shortcut to delete selected entities: Press `Delete` key to remove\n selected entity from the level.\n- Copy/paste support for entities: Use `Ctrl+C` to copy and `Ctrl+V` to paste\n entities with all their components and values.\n - Cross-editor entity copying: Entities can be copied between different level\n editors through system clipboard (opt in via the `arboard` feature)\n - If `arboard` is not enabled the copy/paste will not be cross-editor\n- Entity deletion via keyboard in addition to the existing UI button.\n- Auto-selection of pasted entities: Newly pasted entities are automatically\n selected for immediate editing.\n- UI editing support for `Vpeol3dRotation` using Euler angles (X, Y, Z in\n degrees)\n- UI editing support for `Vpeol3dScale` with separate X, Y, Z drag values.\n- UI editing support for `Vpeol2dRotatation` using degrees.\n- UI editing support for `Vpeol2dScale` with separate X, Y drag values.\n- `Vpeol3dSnapToPlane` to force an entity on a specific plane.\n\n### Changed\n- Improved editor ergonomics with better organized workspace instead of single\n cluttered panel.\n- Move camera with keyboard (WASD, with Q and E too for FPS camera) insted of\n mouse dragging.\n- Use registered systems instead of `YoleckEditorSection`.\n- `YoleckRawEntry::data` is now a `Map` instead of a `Value`.\n- Upgrade Rust edition to 2024.\n- Update bevy_egui version to 0.38.\n\n### Removed\n- [**BREAKING**] Removed `Vpeol3dThirdAxisWithKnob` component (no longer needed\n as all axes have knobs by default)\n- Removed `plane_origin` field from `Vpeol3dCameraControl` (it was used for\n movement by mouse-drag, which was dropped)\n- Removed `YoleckEditorSection`.\n\n## 0.29.0 - 2025-10-03\n### Changed\n- Upgrade Bevy to 0.17\n- Rename:\n - `YoleckSystemSet` -> `YoleckSystems`\n - `VpeolSystemSet` -> `VpeolSystems`\n\n## 0.28.0 - 2025-08-05\n### Changed\n- Update bevy_egui version to 0.36.\n\n## 0.27.0 - 2025-07-03\n### Changed\n- Update bevy_egui version to 0.35.\n\n## 0.26.1 - 2025-06-04\n### Fixed\n- Don't fail when adding `VpeolRouteClickTo` to a non-existing child.\n\n## 0.26.0 - 2025-04-26\n### Changed\n- Upgrade Bevy to 0.16\n- [**BREAKING**] Rename `YoleckEdit`'s method `get_single` and `get_single_mut`\n to `single` and `single_mut` (to mirror a similar change in Bevy itself)\n- Replace anyhow usage with `BevyError`.\n\n## 0.25.0 - 2025-02-19\n### Changed\n- Update bevy_egui version to 0.33.\n\n## 0.24.0 - 2025-01-09\n### Changed\n- Update bevy_egui version to 0.32.\n\n## 0.23.0 - 2024-12-02\n### Changed\n- Update Bevy version to 0.15 and bevy_egui version to 0.31.\n\n## 0.22.0 - 2024-07-06\n### Changed\n- Upgrade Bevy to 0.14 (and bevy_egui to 0.28)\n\n## 0.21.0 - 2024-05-08\n### Changed\n- Update bevy_egui version to 0.27.\n\n## 0.20.1 - 2024-04-01\n### Fixed\n- Enable bevy_egui's `render` feature, so that users won't need to load it\n explicitly and can use the one reexported from Yoleck (fixes\n https://github.com/idanarye/bevy-yoleck/issues/39)\n\n## 0.20.0 - 2024-03-19\n### Changed\n- Update bevy_egui version to 0.26.\n\n## 0.19.0 - 2024-02-27\n### Changed\n- Update Bevy version to 0.13 and bevy_egui version to 0.25.\n- [**BREAKING**] Changed some API types to use Bevy's new math types. See the\n [migration guide](MIGRATION-GUIDES.md#migrating-to-yoleck-019).\n\n## 0.18.0 - 2024-02-18\n### Changed\n- Upgrade bevy_egui to 0.24.\n\n### Fixed\n- [**BREAKING**] Typo - `Rotatation` -> `Rotation` in Vpeol.\n\n## 0.17.1 - 2024-01-14\n### Fixed\n- Use a proper `OR` syntax for the dual license.\n\n## 0.17.0 - 2023-11-25\n### Removed\n- [**BREAKING**] The `YoleckLoadingCommand` resource is removed, in favor of a\n `YoleckLoadLevel` component. See the [migration\n guide](MIGRATION-GUIDES.md#migrating-to-yoleck-017).\n - Note that unlike `YoleckLoadingCommand` that could load the level from\n either an asset or a value, `YoleckLoadLevel` can only load from an asset.\n If it is necessary to load a level from memory, add it to\n `ResMut>` first and pass the handle to\n `YoleckLoadLevel`.\n- [**BREAKING**] The `yoleck_populate_schedule_mut` method (which Yoleck was\n adding as an extension on Bevy's `App`) is removed in favor of just using\n `YoleckSchedule::Populate` directly.\n\n### Added\n- `YoleckEditableLevels` resource (accessible only from edit systems) that\n provides the list of level file names.\n- Entity reference with `YoleckEntityUuid` and `YoleckUuidRegistry`.\n - Some picking helpers for handling entity references in the editor:\n `vpeol_read_click_on_entity`, `yoleck_map_entity_to_uuid` and\n `yoleck_exclusive_system_cancellable`.\n- Load multiple levels with `YoleckLoadLevel` (which is a component, that can\n be placed on multiple entities)\n- Unload levels by removing the `YoleckKeepLevel` component from the entity\n that was used to load the level - or by despawning that entity entirely.\n- `YoleckSchedule::LevelLoaded` schedule for interfering with levels before\n populating their entities.\n- `VpeolRepositionLevel` component.\n\n### Change\n- `YoleckBelongsToLevel` now points to a level entity.\n- `YoleckDirective::spawn_entity` needs to know which level entity to create\n the component on.\n\n## 0.16.0 - 2023-09-06\n### Changed\n- Upgrade Bevy to 0.12 (and bevy_egui to 0.23)\n\n## 0.15.0 - 2023-10-15\n### Changed\n- Upgrade bevy_egui to 0.22\n- [**BREAKING**] `YoleckUi` is a regular resource again. See the [migration\n guide](MIGRATION-GUIDES.md#migrating-to-yoleck-013).\n\n## 0.14.1 - 2023-07-30\n### Fixed\n- `Vpeol2dCameraControl` reversing the Y axis when panning and zooming.\n\n Note that the implementation of this fix requires that the camera entity will\n have the `VpeolCameraState` component - without it `Vpeol2dCameraControl`\n will not work at all. I do not consider it a breaking change though, because:\n 1. The documentation do imply that you need `VpeolCameraState`.\n 2. `Vpeol3dCameraControl` was already requiring `VpeolCameraState`, and they\n are supposed to be equivalent.\n 3. `vpeol_2d` is useless without `VpeolCameraState`, so I'm not expecting\n anyone to not be using it just so that they can use the camera controls.\n\n So having `Vpeol2dCameraControl` work without `VpeolCameraState` was an\n undocumented feature, and I'm going to release this as a bugfix version, not\n a minor version.\n\n## 0.14.0 - 2023-07-18\n### Changed\n### Added\n- `#[derive(Reflect)]` to several components. Requires the `bevy_reflect` flag.\n\n- [**BREAKING**] Rename `YoleckRouteClickTo` to `VpeolRouteClickTo`.\n\n## 0.13.0 - 2023-07-11\n### Changed\n- Upgrade Bevy to 0.11 (and bevy_egui to 0.21)\n- [**BREAKING**] `YoleckUi` is now a non-`Send` resource. See the [migration\n guide](MIGRATION-GUIDES.md#migrating-to-yoleck-013).\n\n## 0.12.0 - 2023-06-20\n### Added\n- An exclusive systems mechanism for edit systems that operate alone and can\n thus assume control over the input (e.g. mouse motion and clicks)\n- Multiple selection with the Shift key, and `YoleckEdit` methods for editing\n multiple entities.\n\n### Changed\n- When creating a new entity that uses `Vpeol*dPosition`, an exclusive system\n will kick in to allow placing the entity with the mouse (instead of just\n placing it in the origin and letting the user drag it from there)\n\n## 0.11.0 - 2023-04-06\n### Added\n- `YoleckBelongsToLevel` for deciding which entities to despawn when the level\n unloads/restarts. This is added automatically by Yoleck, but should also be\n added to entities created by the game.\n\n## 0.10.0 - 2023-03-28\n### Changed\n- Model detection now raycasts against the meshes in addition to the AABB.\n\n### Added\n- Supported for 2D meshes in vpeol_2d.\n\n## 0.9.0 - 2023-03-27\n### Changed\n- [**BREAKING**] This entire release is a huge breaking change. See the\n [migration guide](MIGRATION-GUIDES.md#migrating-to-yoleck-09).\n- [**BREAKING**] Move to a new model, where each Yoleck entity can be composed\n of multiple `YoleckComponent`s.\n- [**BREAKING**] The syntax of edit systems and populate systems has\n drastically changed.\n\n### Added\n- A mechanism for upgrading entity's data when their layout changes. See\n `YoleckEntityUpgradingPlugin`. This can be used to upgrade old games to use\n the new semantics introduced in this version.\n- `vpeol_3d` is back in, without the dependencies and with better dragging.\n- `yoleck::prelude`\n- `yoleck::vpeol::prelude`\n\n### Removed\n- `vpeol_position_edit_adapter` and `VpeolTransform2dProjection`. Use `Vpeol2dPosition` instead.\n\n## 0.8.0 - 2023-03-14\n### Changed\n- Add scroll area to editor window.\n\n### Fixed\n- Panic that happens sometimes when dragging an entity with children.\n\n### Added\n- `YoleckDirective::spawn_entity` for spawning entities from user code (e.g.\n for creating entity duplication buttons)\n\n## 0.7.0 - 2023-03-09\n### Changed\n- Upgrade Bevy to 0.10 (and bevy_egui to 0.20)\n- [**BREAKING**] `VpeolSystemLabel` becomes `VpeolSystems`, and uses Bevy's\n new system set semantics instead of the removed system label semantics. All\n sets of that system are configured to run during the `EditorActive` state.\n\n### Added\n- `Anchor` is taken into account when vpeol_2d checks clicks on text (previous to\n Bevy 0.10 it did not have an `Anchor` component, and just used top-left)\n\n## 0.6.0 - 2023-03-06\n### Changed\n- [**BREAKING**] Vpeol names no longer container the \"yoleck\" prefix - so\n `YoleckVpeolXYZ` becomes `VpeolXYZ` and `yoleck_vpeol_xyz` becomes\n `vpeol_xyz`. Vpeol is enough to avoid conflicts.\n- [**BREAKING**] `vpeol_2d` sends drag coordinates as `Vec3`, not `Vec2`.\n- [**BREAKING**] `YoleckWillContainClickableChildren` is renamed to\n `VpeolWillContainClickableChildren` and is no longer reexported by\n `vpeol_2d`.\n\n### Added\n- [**BREAKING**] `VpeolCameraState` - must be placed on a camera in order for\n vpoel to work.\n- [**BREAKING**] `Vpeol2dCameraControl` - must be placed on a camera in order\n for vpoel_2d to apply camera panning and scrolling.\n\n## 0.5.0 - 2023-02-22\n### Changed\n- Update bevy-egui version to 0.19.\n\n## 0.4.0 - 2022-11-14\n### Changed\n- Update Bevy version to 0.9 and bevy-egui version to 0.17.\n\n### Added\n- Ability to revert levels to their initial state:\n - `Wipe Level` button for ne` levels.\n - `REVERT` button for existing levels\n - This is important because otherwise the only ways to select a different\n level are to save the changes or restart the editor.\n\n### Fixed\n- Knobs remaining during playtest.\n\n## 0.3.0 - 2022-08-18\n### Changed\n- Update Bevy version to 0.8 and bevy-egui version to 0.15.\n\n### Removed\n- **REGRESSION**: Removed `vpeol_3d` and `example3d`. They were depending on\n crates that were slow to migrate to Bevy 0.8 (one of then has still not\n released its Bevy 0.8 version when this changelog entry was written). Since\n `vpeol_3d` was barely usable to begin with (the gizmo is not a good way to\n move objects around - we need proper dragging! - and `bevy_mod_pickling`\n required lots of hacks to play nice with Yoleck) it has been removed for now\n and will be re-added in the future with less dependencies and better\n interface.\n\n### Fixed\n- Use the correct transform when dragging child entities (#11)\n\n### Added\n- Knobs!\n\n## 0.2.0 - 2022-06-09\n### Added\n- `YoleckVpeolSelectionCuePlugin` for adding a pulse effect to show the\n selected entity in the viewport.\n\n## 0.1.1 - 2022-06-02\n### Fixed\n- `vpeol_3d`: Entities sometimes getting deselected when cursor leaves egui area.\n- `vpeol_3d`: Freshly created entities getting selected in Yoleck but Gizmo is not shown.\n\n## 0.1.0 - 2022-06-01\n### Added\n- Building `YoleckTypeHandler`s to define the entity types.\n- Editing entity structs with egui.\n- Populating entities with components based on entity structs.\n- Editor file manager.\n- Level loading from files.\n- Level index loading.\n- `vpeol_2d` and `vpeol_3d`.\n" }, { "path": "Cargo.toml", "content": "[workspace]\nmembers = [\"macros\"]\n\n[workspace.package]\nedition = \"2024\"\nauthors = [\"IdanArye \", \"dexsper \"]\nlicense = \"MIT OR Apache-2.0\"\nrepository = \"https://github.com/idanarye/bevy-yoleck\"\n\n[package]\nname = \"bevy-yoleck\"\ndescription = \"Your Own Level Editor Creation Kit\"\nversion = \"0.31.0\"\nedition.workspace = true\nauthors.workspace = true\nlicense.workspace = true\nrepository.workspace = true\ndocumentation = \"https://docs.rs/bevy-yoleck\"\nreadme = \"README.md\"\ncategories = [\"game-development\"]\nkeywords = [\"bevy\", \"gamedev\", \"level-editor\"]\nexclude = [\"assets\"]\n\n# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html\n\n[dependencies]\nbevy-yoleck-macros = { version = \"0.10.0\", path = \"macros\" }\nbevy = { version = \"^0.18\", default-features = false, features = [\n \"bevy_state\",\n \"bevy_window\",\n \"bevy_asset\",\n \"bevy_log\",\n \"bevy_camera\",\n] }\nbevy_egui = { version = \"^0.39\", default-features = false, features = [\n \"default_fonts\",\n \"render\",\n] }\nserde = \"^1\"\nserde_json = \"^1\"\nthiserror = \"^2\"\nuuid = \"1.9.1\"\narboard = {version = \"3.4\", optional = true}\n\n[features]\nbevy_reflect = []\nvpeol = []\nvpeol_2d = [\"vpeol\", \"bevy/bevy_text\", \"bevy/bevy_sprite\", \"bevy/png\"]\nvpeol_3d = [\"vpeol\", \"bevy/bevy_pbr\"]\n# Support clipboard with the Arboard crate. Otherwise the clipboard will be internal.\narboard = [\"dep:arboard\"]\n# Enable Wayland support in Arboard.\narboard_wayland = [\"arboard\", \"arboard/wayland-data-control\"]\n_example2d_full = [\"vpeol_2d\", \"bevy/bevy_gizmos\", \"bevy/bevy_sprite_render\"]\n_example3d_full = [\n \"vpeol_3d\",\n \"bevy/bevy_scene\",\n \"bevy/bevy_gltf\",\n \"bevy/bevy_animation\",\n \"bevy/ktx2\",\n \"bevy/zstd_rust\",\n \"bevy/tonemapping_luts\",\n \"bevy/bevy_gizmos\",\n \"bevy/reflect_auto_register\",\n \"bevy/bevy_sprite_render\",\n]\n_doors_to_other_levels_full = [\"vpeol_2d\", \"bevy/bevy_sprite_render\"]\n\n[dev-dependencies]\nbevy = { version = \"^0.18\", default-features = false, features = [\n \"bevy_sprite\",\n \"x11\",\n \"bevy_window\",\n \"bevy_text\",\n \"bevy_render\",\n] }\n\n[[example]]\nname = \"example2d\"\nrequired-features = [\"_example2d_full\"]\n\n[[example]]\nname = \"example3d\"\nrequired-features = [\"_example3d_full\"]\n\n[[example]]\nname = \"custom_camera3d\"\nrequired-features = [\"_example3d_full\"]\n\n[[example]]\nname = \"doors_to_other_levels\"\nrequired-features = [\"_doors_to_other_levels_full\"]\n\n[package.metadata.docs.rs]\n\nall-features = true\nfeatures = [\n \"bevy/x11\", # required for bevy_egui\n \"bevy/bevy_gltf\", # required for SceneRoot in vpeol_3d's doctests\n]\n" }, { "path": "LICENSE-APACHE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\nTERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\nEND OF TERMS AND CONDITIONS\n\nAPPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\nCopyright [yyyy] [name of copyright owner]\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n\thttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n" }, { "path": "LICENSE-MIT", "content": "Permission is hereby granted, free of charge, to any\nperson obtaining a copy of this software and associated\ndocumentation files (the \"Software\"), to deal in the\nSoftware without restriction, including without\nlimitation the rights to use, copy, modify, merge,\npublish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software\nis furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice\nshall be included in all copies or substantial portions\nof the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF\nANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED\nTO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A\nPARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT\nSHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR\nIN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\nDEALINGS IN THE SOFTWARE.\n" }, { "path": "MIGRATION-GUIDES.md", "content": "# Migrating to Yoleck 0.19\n\n## Using the new Bevy types\n\nBevy 0.13 introduces types for defining directions and planes, which can be used instead of vectors. Yoleck (mainly Vpeol) uses them now in its API. The conversion should be straightforward.\n\nSpecifically:\n\n- `VpeolDragPlane` now uses `Plane3d`.\n- `Vpeol3dPluginForEditor` also uses `Plane3d`.\n- `Vpeol3dCameraControl` uses `Plane3d` for the camera drag plane, and\n`Direction3d` for configuring the UP direction to maintain while rotating\nthe camera.\n\n## `vpeol_read_click_on_entity`\n\nBevy 0.13 [split `WorldQuery` to `QueryData` and `FilterData`](https://bevyengine.org/learn/migration-guides/0-12-to-0-13/#split-worldquery-into-querydata-and-queryfilter) (though there is still a `WorldQuery` trait with some of that functionality). When you use `vpeol_read_click_on_entity`, the data passed to it is `QueryFilter`, not `QueryData` - which measn that if it's a component (which should usually be the case) you need `vpeol_read_click_on_entity::>` and not `vpeol_read_click_on_entity::<&MyComponent>` (which would have worked before)\n\n# Migrating to Yoleck 0.17\n\n## Loading levels\n\nInstead of a `YoleckLoadingCommand` resource, level loading is now done via entities. This means that instead of loading a level like this:\n```rust\nfn load_level(\n mut yoleck_loading_command: ResMut,\n asset_server: Res,\n) {\n *yoleck_loading_command = YoleckLoadingCommand::FromAsset(asset_server.load(\"levels/my-level.yol\"));\n}\n```\n\nYou should do it like this:\n```rust\nfn load_level(\n mut commands: Commands,\n asset_server: Res,\n) {\n commands.spawn(YoleckLoadLevel(asset_server.load(\"levels/my-level.yol\")));\n}\n```\n\nNote that `YoleckLoadLevel` does not provide an equivalent for `YoleckLoadingCommand::FromData`. If you need to load a level from a value, put that value in `Assets` first.\n\n## Clearing levels\n\nInstead of despawning all the entities marked with `YoleckBelongsToLevel`:\n\n```rust\nfn unload_level(\n query: Query>,\n mut commands: Commands,\n) {\n for entity in query.iter() {\n commands.entity(entity).despawn_recursive();\n }\n}\n```\n\nYou should despawn the entities that represent the levels - the ones marked with `YoleckKeepLevel`:\n\n```rust\nfn unload_old_levels(\n query: Query>,\n mut commands: Commands,\n) {\n for entity in query.iter() {\n commands.entity(entity).despawn_recursive();\n }\n}\n```\n\nYoleck will automatically despawn (with `despawn_recursive`) all the entities that belong to these levels.\n\nNote that it is also possible, if needed, to just remove the `YoleckKeepLevel` component from these entities to despawn their entities without despawning the level entities themselves.\n\n## Changes in `YoleckBelongsToLevel`\n\n`YoleckBelongsToLevel` now has a `pub level: Entity` field that specifies which level the entity belongs to. When unloading a level (by despawning a `YoleckKeepLevel` entity, or removing the `YoleckKeepLevel` component from it), the entities that will be despawned are the ones who's `YoleckBelongsToLevel` points at that level.\n\nAs before, if you create a component from a system and want it to be despawned when switching a level or restarting/finishing a playtest in the editor, it still needs the `YoleckBelongsToLevel` component. Except now you have to provide a level entity for it. Where should the level entity come from? Two options:\n\n* It can be attached to an existing level, so that its lifetime will be bound to it. This is useful for entities that need to exist in the level's space - when despawning the level, we don't want these entities to remain.\n\n The easiest way to achieve this is to use the `YoleckBelongsToLevel` of another component in that level. For example - say you have a treasure chest, and when the player shoots at it it opens up and a powerup pops from it for the player to pick up. Since the chest should already have a `YoleckBelongsToLevel` component, and since the system that spawns the powerup should already need to use some components of the chest entity, it should be easy to just clone the chest's `YoleckBelongsToLevel` and add it to the powerup spawning command.\n\n* You can create a faux level and attach the entities to it. This is useful, for example, for a player character entity that can travel between levels. Just create a new entity with a `YoleckKeepLevel` component and add its `Entity` to the roaming entity inside a `YoleckBelongsToLevel` component.\n\n Note that you can freely set an existing `YoleckBelongsToLevel` to point to different levels. So it might make more sense to switch the player character entity to different level as it travels between them than to associate it to some faux level. Both options are available.\n\n## Adding populate systems\n\n\n`yoleck_populate_schedule_mut` is removed - this no longer works:\n\n```rust\napp.yoleck_populate_schedule_mut().add_systems(my_populate_system);\n```\n\nInstead, just add the system on the `YoleckSchedule::Populate` schedule:\n```rust\napp.add_systems(YoleckSchedule::Populate, my_populate_system);\n```\n\n`yoleck_populate_schedule_mut` made ergonomic sense in Bevy 0.10, but since starting Bevy 0.11 one has to always specify the schedule, it is no longer that ergonomic to have this helper method.\n\n# Migrating to Yoleck 0.15\n\n## Accessing the YoleckUi\n\nNow that https://github.com/emilk/egui/pull/3233 got in to egui 0.23, and bevy_egui 0.22 was released with that new version of egui, `YoleckUi` can be made a regular resource again.\n\n`YoleckUi` can no longer be accessed with `NonSend`/`NonSendMut`, and must be accessed with the regular `Res`/`ResMut`.\n\n# Migrating to Yoleck 0.13\n\n## Accessing the YoleckUi\n\n`YoleckUi` is now a non-`Send` resource, which means it can no longer be accessed as a regular `Res`/`ResMut`. It must now be accessed as `NonSend`/`NonSendMut`.\n\nHopefully once https://github.com/emilk/egui/issues/3148 is fixed (and gets in to bevy_egui) this can be changed back.\n\n# Migrating to Yoleck 0.9\n\n## Importing\n\nMost of the commonly used stuff can be imported from the new prelude module:\n\n```rust\nuse bevy_yoleck::prelude::*;\n```\n\n## Entity type definition and registration\n\nPreviously entity types were declared as struct:\n\n```rust\n#[derive(Clone, PartialEq, Serialize, Deserialize)]\nstruct Foo {\n #[serde(default)]\n bar: Bar,\n #[serde(default)]\n baz: Baz,\n}\n```\n\nAnd registered with:\n\n```rust\napp.add_yoleck_handler({\n YoleckTypeHandler::::new(\"Foo\")\n .populate_with(populate_foo)\n .edit_with(edit_foo)\n});\n```\n\nStarting from 0.9, entities can be broken to multiple components:\n```rust\n#[derive(Default, Clone, PartialEq, Serialize, Deserialize, Component, YoleckComponent)]\nstruct Bar {\n // ...\n}\n\n#[derive(Default, Clone, PartialEq, Serialize, Deserialize, Component, YoleckComponent)]\nstruct Baz {\n // ...\n}\n```\n\nYou can still create one big component per entity type, but if there are data\nfields that are shared between different entity types it's better to split them\nout so that they can be edited with the same edit systems.\n\nInstead of registering type handlers, register entity types:\n\n```rust\napp.add_yoleck_entity_type({\n YoleckEntityType::new(\"Foo\")\n .with::()\n .with::()\n});\n```\n\nUnlike `YoleckTypeHandler`, that specifies the one data structure used by the\nentity and all the edit and populate systems it'll have, `YoleckEntityType` can\nspecify multiple components and no systems. Systems are registered separately,\nand are not bound to a single entity type:\n\n```rust\napp.add_yoleck_edit_system(edit_bar);\napp.add_yoleck_edit_system(edit_baz);\napp.yoleck_populate_schedule_mut().add_systems((\n populate_bar,\n populate_baz,\n));\n```\n\n## Edit systems\n\nIn addition to the different method of registreation specified in the previous\nsection, the semantics of edit systems has also changed.\n\nPreviously, edit systems would use a closure:\n\n```rust\nfn edit_foo(mut edit: YoleckEdit) {\n edit.edit(|ctx, data, ui| {\n // ...\n });\n}\n```\n\nNow they use something that acts like a query:\n\n```rust\nfn edit_foo(mut ui: ResMut, mut edit: YoleckEdit<&mut Foo>) {\n let Ok(mut foo) = edit.get_single_mut() else { return };\n // ...\n}\n```\n\nThe differences:\n\n* Instead of a closure, we use `get_single_mut` to get the single entity. If no\n entity is being edited, or if the edited entity does not match, we use\n `return` to skip the rest of the edit system.\n * In the future, when Yoleck will have multi-entity editing, `YoleckEdit`\n will have `iter` and `iter_mut` for edit systems that can edit multiple\n entities.\n* Instead of getting the entity type directly as a generic parameter (`Foo`),\n `YoleckEdit` gets it like Bevy `Query`s would (`&mut Foo`). In fact,\n `YoleckEdit` can accept anything a Bevy query would accept, including filters\n as a second parameter.\n* Instead of getting the UI handle via a closure argument, we get it as a\n resource in a separate `SystemParam` argument for the edit system function.\n\n## Populate systems\n\nIn addition to the different method of registreation specified in an earlier\nsection, the semantics of populate systems has also changed.\n\nPreviously, populate systems would look like this:\n\n```rust\nfn populate_foo(mut populate: YoleckPopulate) {\n populate.populate(|ctx, data, &mut cmd| {\n // ...\n });\n}\n```\n\nPopulate systems still use closures, but they look different:\n\n```rust\nfn populate_foo(mut populate: YoleckPopulate<&Foo>) {\n populate.populate(|ctx, &mut cmd, foo| {\n // ...\n });\n}\n```\n\nThe differences:\n\n* Like `YoleckEdit`, `YoleckPopulate` also accepts query-like generic parameters.\n* The command and data arguments to the closure switch places. Now the command\n is the second argument and the data is the third.\n* The data argument is actually what a Bevy query with the same generic\n parameters as what the `YoleckPopulate` got would have yielded.\n\n## Child entities\n\nPreviously, a populate system could freely use `cmd.despawn_descendants();`.\nNow that there are multiple edit systems and their order is determined by a\nscheduler, this should not be used, so instead populate systems should mark\nchild entities they create so that they can despawn them later (usually when\nthey replace them with freshly spawned ones):\n\n```rust\nfn populate_system(mut populate: YoleckPopulate<&MyComponent>, marking: YoleckMarking) {\n populate.populate(|_ctx, mut cmd, my_component| {\n marking.despawn_marked(&mut cmd);\n cmd.with_children(|commands| {\n let mut child = commands.spawn(marking.marker());\n child.insert((\n // relevant Bevy components\n ));\n });\n });\n}\n```\n\n## Passed data\n\nPreviously, passed data would be accessed from the context argument of an edit system's closure:\n\n## Knobs\n\nPreviously, knobs would be accessed from the context argument of an edit system's closure:\n\n```rust\nfn edit_foo(mut edit: YoleckEdit, mut commands: Commands) {\n edit.edit(|ctx, data, ui| {\n let mut knob = ctx.knob(&mut commands, \"knob-ident\");\n });\n}\n```\n\nStarting from 0.9 knobs are accessed with a new `SystemParam` named `YoleckKnobs`:\n\n```rust\nfn edit_foo(mut edit: YoleckEdit<&mut Foo>, mut knobs: YoleckKnobs) {\n let Ok(mut foo) = edit.get_single_mut() else { return };\n let mut knob = knobs.knob(\"knob-ident\");\n}\n```\n\nThe actual usage of the knob handle is unchained.\n\nNote that knobs are not associated to a specific edited entity (although they\ndo reset when the selection changes). This was also true before 0.9, but is\nmore visible now that they are not accessed from the edit closure's `ctx`.\n\n## Position manipulation with vpeol_2d\n\n* Instead of `vpeol_position_edit_adapter`, use `Vpeol2dPosition` as a Yoleck component.\n* Don't set the translation by yourself - let vpeol_2d do it.\n* If you need to also set rotation and scale, use `Vpeol2dRotatation` and\n `Vpeol2dScale`. vpeol_2d does not currently offer edit systems for them (it\n only takes them into account in the populate system), so you'll still have to\n write them yourself.\n* `Vpeol2dPlugin` is split into two - `Vpeol2dPluginForEditor` and\n `Vpeol2dPluginForGame`. Use the appropriate one based on how the process\n started, just like you'd use the appropriate\n `YoleckPluginForEditor`/`YoleckPluginForGame`.\n" }, { "path": "README.md", "content": "[![Build Status](https://github.com/idanarye/bevy-yoleck/workflows/CI/badge.svg)](https://github.com/idanarye/bevy-yoleck/actions)\n[![Latest Version](https://img.shields.io/crates/v/bevy-yoleck.svg)](https://crates.io/crates/bevy-yoleck)\n[![Rust Documentation](https://img.shields.io/badge/nightly-rustdoc-blue.svg)](https://idanarye.github.io/bevy-yoleck/)\n[![Rust Documentation](https://img.shields.io/badge/stable-rustdoc-purple.svg)](https://docs.rs/bevy-yoleck/)\n\n# Bevy YOLECK - Your Own Level Editor Creation Kit\n\nYoleck is a crate for having a game built with the Bevy game engine act as its\nown level editor.\n\n## Features\n\n* Same executable can launch in either game mode or editor mode, depending on\n the plugins added to the app.\n* Write systems that create entities based on serializable structs - use same\n systems for both loading the levels and visualizing them in the editor.\n* Entity editing is done with egui widgets that edit these structs.\n| * Automatic UI generation for components with support for numeric, boolean, string, vector, color, enum, option, list, asset, and entity fields.\n| * Entity linking system with automatic UI, filtering, and runtime UUID resolution. Supports drag-and-drop.\n * Visual scene gizmo for camera orientation and control.\n* Support for external plugins that offer more visual editing.\n * One simple such plugin - Vpeol is included in the crate. It provides basic\n entity selection, positioning with mouse dragging, and basic camera\n control. It has two variants behind feature flags - `vpeol_2d` and\n `vpeol_3d`.\n* A knobs mechanism for more visual editing.\n* Playtest the levels inside the editor.\n* Multiple entity selection in the editor with the Shift key.\n* Optional console system for displaying logs in the UI |\n\n## Examples:\n\n```bash\ngit clone https://github.com/dexsper/bevy-yoleck-fork\ncd bevy-yoleck\n```\n\nThen you can run the examples:\n\n* 2D example:\n ```bash\n cargo example2d\n ```\n Or check out the WASM version: https://idanarye.github.io/bevy-yoleck/demos/example2d\n\n https://user-images.githubusercontent.com/1149255/228007948-31a37b3f-7bd3-4a36-a3bc-4617d359c7c2.mp4\n\n* 3D example:\n ```bash\n cargo example3d\n ```\n Or check out the WASM version: https://idanarye.github.io/bevy-yoleck/demos/example3d\n\n https://user-images.githubusercontent.com/1149255/228008014-825ef02e-2edc-49f5-a15c-1fa6044f84de.mp4\n\n* Multi-level example:\n ```bash\n cargo doors_to_other_levels\n ```\n Or check out the WASM version (gameplay only): https://idanarye.github.io/bevy-yoleck/demos/doors_to_other_levels\n\n https://github.com/idanarye/bevy-yoleck/assets/1149255/590beba4-2ca5-4218-af52-143321bb5946\n\n## File Format\n\nYoleck saves the levels in JSON files that have the `.yol` extension. A `.yol`\nfile's top level is a tuple (actually JSON array) of three values:\n\n* File metadata - e.g. Yoleck version.\n* Level data (placeholder - currently an empty object)\n* List of entities.\n\nEach entity is a tuple of two values:\n\n* Entity metadata - e.g. its type.\n* Entity componments - that's the user defined structs.\n\nThe reason tuples are used instead of objects is to ensure ordering - to\nguarantee the metadata can be read before the data. This is important because\nthe metadata is needed to parse the data.\n\nYoleck generates another JSON file in the same directory as the `.yol` files\ncalled `index.yoli`. The purpose of this file is to let the game know what\nlevel are available to it (in WASM, for example, the asset server cannot look\nat a directory's contents). The index file contains a tuple of two values:\n\n* Index metadata - e.g. Yoleck version.\n* List of objects, each contain a path to a level file relative to the index\n file.\n\n## Versions\n\n| bevy | bevy-yoleck | bevy_egui |\n|------|-------------|-----------|\n| 0.18 | 0.31 | 0.39 |\n| 0.17 | 0.30 | 0.38 |\n| 0.17 | 0.29 | 0.37 |\n| 0.16 | 0.28 | 0.36 |\n| 0.16 | 0.27 | 0.35 |\n| 0.16 | 0.26 | 0.34 |\n| 0.15 | 0.25 | 0.33 |\n| 0.15 | 0.24 | 0.32 |\n| 0.15 | 0.23 | 0.31 |\n| 0.14 | 0.22 | 0.28 |\n| 0.13 | 0.21 | 0.27 |\n| 0.13 | 0.20 | 0.26 |\n| 0.13 | 0.19 | 0.25 |\n| 0.12 | 0.18 | 0.24 |\n| 0.12 | 0.16, 0.17 | 0.23 |\n| 0.11 | 0.15 | 0.22 |\n| 0.11 | 0.13 - 0.14 | 0.21 |\n| 0.10 | 0.7 - 0.12 | 0.20 |\n| 0.9 | 0.5, 0.6 | 0.19 |\n| 0.9 | 0.4 | 0.17 |\n| 0.8 | 0.3 | 0.15 |\n| 0.7 | 0.1, 0.2 | 0.14 |\n\n## License\n\nLicensed under either of\n\n * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any\nadditional terms or conditions.\n" }, { "path": "assets/levels2d/.gitkeep", "content": "" }, { "path": "assets/levels2d/example.yol", "content": "[{\"format_version\":2,\"app_format_version\":1},{},[[{\"type\":\"Player\",\"name\":\"\"},{\"Vpeol2dPosition\":[-309.3874206542969,81.44441223144531],\"Vpeol2dRotatation\":0.0}],[{\"type\":\"Triangle\",\"name\":\"\"},{\"TriangleVertices\":{\"vertices\":[[-12.283805847167969,-141.28375244140625],[211.94580078125,-151.37274169921875],[199.81985473632812,16.863494873046875]]},\"Vpeol2dPosition\":[-459.87017822265625,-29.312294006347656]}],[{\"type\":\"FloatingText\",\"name\":\"\",\"uuid\":\"8acaa597-8c7d-4b82-8fd5-4eda44e24b5f\"},{\"TextContent\":{\"text\":\"Collect the fruit\"},\"TextLaserPointer\":{\"target\":{}},\"Vpeol2dPosition\":[118.0838623046875,306.9156494140625],\"Vpeol2dScale\":[1.0,1.0]}],[{\"type\":\"FloatingText\",\"name\":\"\",\"uuid\":\"14195c3b-e420-4fa4-bc59-7149a7c7f5d4\"},{\"TextContent\":{\"text\":\"Orange\"},\"TextLaserPointer\":{\"target\":{\"uuid\":\"e8f8d516-ca5f-41d2-99a6-1be029fdd0ee\"}},\"Vpeol2dPosition\":[74.51683044433594,-226.31687927246094],\"Vpeol2dScale\":[0.75,0.75]}],[{\"type\":\"Fruit\",\"name\":\"\",\"uuid\":\"e8f8d516-ca5f-41d2-99a6-1be029fdd0ee\"},{\"FruitType\":{\"index\":1},\"Vpeol2dPosition\":[-3.697650909423828,-60.341732025146484]}],[{\"type\":\"Fruit\",\"name\":\"\",\"uuid\":\"eb26f293-7548-4bcc-a268-871c80726fd3\"},{\"FruitType\":{\"index\":2},\"Vpeol2dPosition\":[-265.73712158203125,-226.1751708984375]}],[{\"type\":\"FloatingText\",\"name\":\"\",\"uuid\":\"e9f7c89f-f975-41e0-9ab0-30991e715877\"},{\"TextContent\":{\"text\":\"Grapes\"},\"TextLaserPointer\":{\"target\":{\"uuid\":\"eb26f293-7548-4bcc-a268-871c80726fd3\"}},\"Vpeol2dPosition\":[-440.10369873046875,-230.0904998779297],\"Vpeol2dScale\":[0.75,0.75]}]]]" }, { "path": "assets/levels3d/.gitkeep", "content": "" }, { "path": "assets/levels3d/example.yol", "content": "[{\"format_version\":2,\"app_format_version\":0},{},[[{\"type\":\"Planet\",\"name\":\"\",\"uuid\":\"c8aa8fdd-5431-473c-8774-b069c95f794f\"},{\"Vpeol3dPosition\":[-7.047080993652344,6.785710334777832,0.0],\"Vpeol3dRotation\":[0.0,0.0,0.0,1.0],\"Vpeol3dScale\":[1.0,1.0,1.0]}],[{\"type\":\"Planet\",\"name\":\"\",\"uuid\":\"2d676a47-146f-49f0-bba7-cf58a8833b1f\"},{\"Vpeol3dPosition\":[16.688783645629883,-3.0687923431396484,0.0],\"Vpeol3dRotation\":[0.0,0.0,0.0,1.0],\"Vpeol3dScale\":[1.0,1.0,1.0]}],[{\"type\":\"Spaceship\",\"name\":\"\"},{\"SpaceshipSettings\":{\"enabled\":true,\"rotation_speed\":2.0,\"speed\":2.0},\"Vpeol3dPosition\":[1.2451118230819702,-2.86102294921875e-6,21.062850952148438]}],[{\"type\":\"PlanetPointer\",\"name\":\"\"},{\"LaserPointer\":{\"target\":{\"uuid\":\"c8aa8fdd-5431-473c-8774-b069c95f794f\"}},\"Vpeol3dPosition\":[3.227558135986328,2.0,-29.523635864257812]}]]]" }, { "path": "assets/levels_doors/entry.yol", "content": "[{\"format_version\":2,\"app_format_version\":0},{},[[{\"type\":\"FloatingText\",\"name\":\"\"},{\"TextContent\":{\"text\":\"Start Room\"},\"Vpeol2dPosition\":[28.116905212402344,132.0689239501953],\"Vpeol2dScale\":[1.0,1.0]}],[{\"type\":\"Doorway\",\"name\":\"\"},{\"Doorway\":{\"marker\":\"s-1\",\"target_level\":\"room1.yol\"},\"Vpeol2dPosition\":[326.6886291503906,-15.409356117248535],\"Vpeol2dRotatation\":0.0}],[{\"type\":\"Player\",\"name\":\"\"},{\"Vpeol2dPosition\":[0.0,0.0]}]]]" }, { "path": "assets/levels_doors/index.yoli", "content": "[{\"format_version\":1},[{\"filename\":\"entry.yol\"},{\"filename\":\"room1.yol\"},{\"filename\":\"room2.yol\"},{\"filename\":\"room3.yol\"}]]" }, { "path": "assets/levels_doors/room1.yol", "content": "[{\"format_version\":2,\"app_format_version\":0},{},[[{\"type\":\"Doorway\",\"name\":\"\"},{\"Doorway\":{\"marker\":\"s-1\",\"target_level\":\"entry.yol\"},\"Vpeol2dPosition\":[-341.4138488769531,-77.32525634765625],\"Vpeol2dRotatation\":-3.1367220878601074}],[{\"type\":\"Doorway\",\"name\":\"\"},{\"Doorway\":{\"marker\":\"1-2\",\"target_level\":\"room2.yol\"},\"Vpeol2dPosition\":[13.468215942382812,371.9578857421875],\"Vpeol2dRotatation\":1.5801841020584106}],[{\"type\":\"Doorway\",\"name\":\"\"},{\"Doorway\":{\"marker\":\"1-3\",\"target_level\":\"room3.yol\"},\"Vpeol2dPosition\":[23.59503173828125,-422.729248046875],\"Vpeol2dRotatation\":-1.5713714361190796}],[{\"type\":\"Player\",\"name\":\"\"},{\"Vpeol2dPosition\":[0.0,0.0]}],[{\"type\":\"FloatingText\",\"name\":\"\"},{\"TextContent\":{\"text\":\"Room 1\"},\"Vpeol2dPosition\":[3.049217939376831,77.6406021118164],\"Vpeol2dScale\":[1.0,1.0]}]]]" }, { "path": "assets/levels_doors/room2.yol", "content": "[{\"format_version\":2,\"app_format_version\":0},{},[[{\"type\":\"Doorway\",\"name\":\"\"},{\"Doorway\":{\"marker\":\"1-2\",\"target_level\":\"room1.yol\"},\"Vpeol2dPosition\":[-5.04287052154541,-384.5793762207031],\"Vpeol2dRotatation\":-1.5634950399398804}],[{\"type\":\"Player\",\"name\":\"\"},{\"Vpeol2dPosition\":[0.0,0.0]}],[{\"type\":\"FloatingText\",\"name\":\"\"},{\"TextContent\":{\"text\":\"Room 2\"},\"Vpeol2dPosition\":[-3.6070098876953125,-112.29154968261719],\"Vpeol2dScale\":[1.0,1.0]}]]]" }, { "path": "assets/levels_doors/room3.yol", "content": "[{\"format_version\":2,\"app_format_version\":0},{},[[{\"type\":\"Doorway\",\"name\":\"\"},{\"Doorway\":{\"marker\":\"1-3\",\"target_level\":\"room1.yol\"},\"Vpeol2dPosition\":[-4.219451904296875,364.6886291503906],\"Vpeol2dRotatation\":1.5755369663238525}],[{\"type\":\"Player\",\"name\":\"\"},{\"Vpeol2dPosition\":[0.0,0.0]}],[{\"type\":\"FloatingText\",\"name\":\"\"},{\"TextContent\":{\"text\":\"Room 3\"},\"Vpeol2dPosition\":[1.2645721435546875,150.7604217529297],\"Vpeol2dScale\":[1.0,1.0]}]]]" }, { "path": "assets/these-assets-are-for-the-examples", "content": "" }, { "path": "examples/custom_camera3d.rs", "content": "use std::path::Path;\n\nuse bevy::color::palettes::css;\nuse bevy::prelude::*;\nuse bevy_egui::{EguiContexts, EguiPlugin};\nuse bevy_yoleck::YoleckEditMarker;\nuse bevy_yoleck::prelude::*;\nuse bevy_yoleck::vpeol::prelude::*;\n\n/// Custom camera mode for isometric view with diagonal movement.\nconst CAMERA_MODE_ISOMETRIC: Vpeol3dCameraMode = Vpeol3dCameraMode::Custom(0);\n/// Custom camera mode for orbital rotation around selected entities.\nconst CAMERA_MODE_ORBITAL: Vpeol3dCameraMode = Vpeol3dCameraMode::Custom(1);\n\nfn main() {\n let mut app = App::new();\n app.add_plugins(DefaultPlugins);\n\n let level = std::env::args().nth(1);\n if let Some(level) = level {\n app.add_plugins(EguiPlugin::default());\n app.add_plugins(YoleckPluginForGame);\n app.add_plugins(Vpeol3dPluginForGame);\n app.add_systems(\n Startup,\n move |asset_server: Res, mut commands: Commands| {\n commands.spawn(YoleckLoadLevel(\n asset_server.load(Path::new(\"levels3d\").join(&level)),\n ));\n },\n );\n } else {\n app.add_plugins(EguiPlugin::default());\n app.add_plugins(YoleckPluginForEditor);\n app.add_plugins(Vpeol3dPluginForEditor::topdown());\n app.add_plugins(VpeolSelectionCuePlugin::default());\n app.insert_resource(bevy_yoleck::YoleckEditorLevelsDirectoryPath(\n Path::new(\".\").join(\"assets\").join(\"levels3d\"),\n ));\n #[cfg(target_arch = \"wasm32\")]\n app.add_systems(\n Startup,\n |asset_server: Res, mut commands: Commands| {\n commands.spawn(YoleckLoadLevel(asset_server.load(\"levels3d/example.yol\")));\n },\n );\n\n app.insert_resource(\n YoleckCameraChoices::default()\n .choice_with_transform(\n \"Isometric\",\n {\n let mut control = Vpeol3dCameraControl::fps();\n control.mode = CAMERA_MODE_ISOMETRIC;\n control.allow_rotation_while_maintaining_up = None;\n control.wasd_movement_speed = 15.0;\n control\n },\n Vec3::new(10.0, 10.0, 10.0),\n Vec3::ZERO,\n Vec3::Y,\n )\n .choice_with_transform(\n \"Orbital\",\n {\n let mut control = Vpeol3dCameraControl::fps();\n control.mode = CAMERA_MODE_ORBITAL;\n control.allow_rotation_while_maintaining_up = None;\n control.wasd_movement_speed = 0.0;\n control.mouse_sensitivity = 0.005;\n control\n },\n Vec3::new(0.0, 5.0, 15.0),\n Vec3::ZERO,\n Vec3::Y,\n ),\n );\n\n app.add_systems(\n PostUpdate,\n isometric_camera_movement.run_if(in_state(YoleckEditorState::EditorActive)),\n );\n app.add_systems(\n PostUpdate,\n orbital_camera_movement.run_if(in_state(YoleckEditorState::EditorActive)),\n );\n }\n\n app.add_systems(Startup, (setup_camera, setup_scene));\n\n app.add_yoleck_entity_type({\n YoleckEntityType::new(\"Cube\")\n .with::()\n .with::()\n .insert_on_init(|| IsCube)\n });\n app.add_systems(YoleckSchedule::Populate, populate_cube);\n\n app.add_yoleck_entity_type({\n YoleckEntityType::new(\"Sphere\")\n .with::()\n .insert_on_init(|| IsSphere)\n });\n app.add_systems(YoleckSchedule::Populate, populate_sphere);\n\n app.run();\n}\n\nfn setup_camera(mut commands: Commands) {\n commands.spawn((\n Camera3d::default(),\n Transform::from_xyz(10.0, 10.0, 10.0).looking_at(Vec3::ZERO, Vec3::Y),\n VpeolCameraState::default(),\n Vpeol3dCameraControl::topdown(),\n ));\n\n commands.spawn((\n DirectionalLight {\n color: Color::WHITE,\n illuminance: 10_000.0,\n shadows_enabled: true,\n ..Default::default()\n },\n Transform::from_xyz(5.0, 10.0, 5.0).looking_at(Vec3::ZERO, Vec3::Y),\n ));\n}\n\nfn setup_scene(\n mut commands: Commands,\n mut mesh_assets: ResMut>,\n mut material_assets: ResMut>,\n) {\n let mesh = mesh_assets.add(Mesh::from(\n Plane3d {\n normal: Dir3::Y,\n half_size: Vec2::new(50.0, 50.0),\n }\n .mesh(),\n ));\n let material = material_assets.add(Color::from(css::DARK_GRAY));\n commands.spawn((\n Mesh3d(mesh),\n MeshMaterial3d(material),\n Transform::from_xyz(0.0, -1.0, 0.0),\n ));\n}\n\nfn isometric_camera_movement(\n mut egui_context: EguiContexts,\n keyboard_input: Res>,\n time: Res