├── .editorconfig ├── .github └── workflows │ └── ci.yml ├── .gitignore ├── .rustfmt.toml ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples ├── controlling.rs ├── setup.rs └── spawning.rs └── src ├── bundles.rs ├── components.rs ├── lib.rs ├── plugins.rs ├── prelude.rs ├── systems.rs └── utils.rs /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | end_of_line = lf 6 | insert_final_newline = true 7 | trim_trailing_whitespace = true 8 | 9 | [*.md] 10 | indent_size = 2 11 | indent_style = space 12 | 13 | [*.rs] 14 | indent_size = 4 15 | indent_style = space 16 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Continuous Integration 2 | on: 3 | pull_request: 4 | push: 5 | branches: 6 | - main 7 | - release/* 8 | tags: 9 | - v* 10 | 11 | concurrency: 12 | group: ${{ github.workflow }}-${{ github.ref }} 13 | cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} 14 | 15 | jobs: 16 | conformance: 17 | name: Conformance 18 | runs-on: "ubuntu-latest" 19 | steps: 20 | - name: Checkout 21 | uses: actions/checkout@v3 22 | 23 | - name: Install Platform Dependencies 24 | run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev 25 | 26 | - name: Cache Rust 27 | uses: actions/cache@v3 28 | with: 29 | key: ${{ runner.os }}-nightly-${{ hashFiles('Cargo.toml') }} 30 | path: | 31 | ~/.cargo/bin/ 32 | ~/.cargo/registry/index/ 33 | ~/.cargo/registry/cache/ 34 | ~/.cargo/git/db/ 35 | target/ 36 | 37 | - name: Setup Rust 38 | uses: actions-rs/toolchain@v1 39 | with: 40 | profile: minimal 41 | toolchain: nightly 42 | components: rustfmt, clippy 43 | override: true 44 | 45 | - name: Rustfmt 46 | uses: actions-rs/cargo@v1 47 | with: 48 | command: fmt 49 | args: --all -- --check 50 | 51 | - name: Clippy 52 | uses: actions-rs/cargo@v1 53 | with: 54 | command: clippy 55 | args: --all --features library -- --deny warnings 56 | 57 | test: 58 | strategy: 59 | matrix: 60 | os: 61 | - windows-latest 62 | - macos-latest 63 | - ubuntu-latest 64 | 65 | name: Test (${{ matrix.os }}) 66 | runs-on: ${{ matrix.os }} 67 | steps: 68 | - name: Checkout 69 | uses: actions/checkout@v2 70 | 71 | - name: Install Platform Dependencies 72 | if: runner.os == 'linux' 73 | run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev 74 | 75 | - name: Cache Rust 76 | uses: actions/cache@v3 77 | with: 78 | key: ${{ runner.os }}-${{ matrix.rust }}-${{ hashFiles('Cargo.toml') }} 79 | path: | 80 | ~/.cargo/bin/ 81 | ~/.cargo/registry/index/ 82 | ~/.cargo/registry/cache/ 83 | ~/.cargo/git/db/ 84 | target/ 85 | 86 | - name: Setup Rust 87 | uses: actions-rs/toolchain@v1 88 | with: 89 | profile: minimal 90 | toolchain: stable 91 | override: true 92 | 93 | - name: Build 94 | uses: actions-rs/cargo@v1 95 | with: 96 | command: build 97 | args: --all --features library 98 | 99 | - name: Test 100 | uses: actions-rs/cargo@v1 101 | with: 102 | command: test 103 | args: --all --features library 104 | 105 | publish: 106 | if: startsWith(github.ref, 'refs/tags/v') 107 | needs: [conformance, test] 108 | 109 | name: Publish 110 | runs-on: "ubuntu-latest" 111 | steps: 112 | - name: Checkout 113 | uses: actions/checkout@v2 114 | 115 | - name: Install Platform Dependencies 116 | run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev 117 | 118 | - name: Setup Rust 119 | uses: actions-rs/toolchain@v1 120 | with: 121 | profile: minimal 122 | toolchain: stable 123 | override: true 124 | 125 | - name: Publish 126 | run: cargo publish --features library --token ${REGISTRY_TOKEN} 127 | env: 128 | REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} 129 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # JetBrains IDEs 2 | .idea 3 | 4 | # Rust 5 | /target 6 | Cargo.lock 7 | 8 | # Visual Studio Code 9 | .vscode 10 | -------------------------------------------------------------------------------- /.rustfmt.toml: -------------------------------------------------------------------------------- 1 | edition = "2021" 2 | version = "Two" 3 | unstable_features = true 4 | 5 | blank_lines_upper_bound = 2 6 | combine_control_expr = false 7 | force_multiline_blocks = true 8 | imports_layout = "Vertical" 9 | match_block_trailing_comma = true 10 | merge_derives = false 11 | imports_granularity = "Crate" 12 | newline_style = "Unix" 13 | normalize_comments = true 14 | normalize_doc_attributes = true 15 | group_imports = "Preserve" 16 | use_field_init_shorthand = true 17 | use_small_heuristics = "Max" 18 | use_try_shorthand = true 19 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "bevy-persistent-windows" 3 | description = "A Bevy plugin to easily create and manage windows that remember where they were." 4 | categories = ["game-development"] 5 | keywords = ["gamedev", "bevy", "persistent", "window"] 6 | repository = "https://github.com/umut-sahin/bevy-persistent-windows/" 7 | version = "0.8.0" 8 | edition = "2021" 9 | license = "MIT OR Apache-2.0" 10 | authors = [ 11 | "Umut Şahin ", 12 | ] 13 | 14 | [dependencies] 15 | bevy = { version = "0.16", default-features = false, features = ["bevy_window", "bevy_winit", "serialize"] } 16 | bevy-persistent = { version = "0.8" } 17 | serde = { version = "1.0", features = ["derive"] } 18 | winit = { version = "0.30", default-features = false } 19 | 20 | [dev-dependencies] 21 | dirs = { version = "5.0" } 22 | bevy = { version = "0.16" } 23 | bevy-persistent = { version = "0.8", features = ["toml"] } 24 | 25 | [features] 26 | default = ["x11"] 27 | library = ["bevy-persistent/library"] 28 | x11 = ["bevy/x11"] 29 | 30 | [package.metadata.docs.rs] 31 | features = ["library"] 32 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Umut Şahin 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # bevy-persistent-windows 2 | 3 | A [Bevy](https://bevyengine.org/) plugin to easily create and manage windows that remember where they were. 4 | 5 | ## Background 6 | 7 | When you're developing a game, thus frequently restarting it, you may (understandably) desire that the windows just stay where they were in the last run. Implementing this manually in every project you create is error-prone and time-consuming (trust me, I know). This plugin aims to make it as seamless as possible! 8 | 9 | ## Installation 10 | 11 | We'll be using [bevy-persistent](https://github.com/umut-sahin/bevy-persistent/) to store window states persistently, so let's add it first: 12 | 13 | ```shell 14 | cargo add bevy-persistent --features all # you probably don't need all features, see installation section of bevy-persistent to learn more 15 | ``` 16 | 17 | Now let's add [bevy-persistent-windows](https://github.com/umut-sahin/bevy-persistent-windows/) to make our windows persistent: 18 | 19 | ```shell 20 | cargo add bevy-persistent-windows 21 | ``` 22 | 23 | ## Usage 24 | 25 | ### Prelude 26 | 27 | As mentioned before, we'll be using [bevy-persistent](https://github.com/umut-sahin/bevy-persistent/) to store the window state persistently, so lets prelude it first: 28 | 29 | ```rust 30 | use bevy_persistent::prelude::*; 31 | ``` 32 | 33 | We need [WindowState](https://docs.rs/bevy-persistent-windows/latest/bevy_persistent_windows/components/struct.WindowState.html), [PersistentWindowBundle](https://docs.rs/bevy-persistent-windows/latest/bevy_persistent_windows/bundles/struct.PersistentWindowBundle.html) and [PersistentWindowsPlugin](https://docs.rs/bevy-persistent-windows/latest/bevy_persistent_windows/plugins/struct.PersistentWindowsPlugin.html) types to use the library, and they are exported from the prelude module: 34 | 35 | ```rust 36 | use bevy_persistent_windows::prelude::*; 37 | ``` 38 | 39 | ### Setup 40 | 41 | Let's start by creating an `App` within `main`: 42 | 43 | ```rust 44 | let mut app = App::new(); 45 | ``` 46 | 47 | We'll add the default plugins to this app, but we should edit the window plugin to avoid creating a default primary window: 48 | 49 | ```rust 50 | let window_plugin = WindowPlugin { primary_window: None, ..Default::default() }; 51 | app.add_plugins(DefaultPlugins.set(window_plugin).build()); 52 | ``` 53 | 54 | We need somewhere to store the window state, to restore the window later: 55 | 56 | ```rust 57 | let state_directory = dirs::data_dir() 58 | .expect("failed to get the platforms data directory") 59 | .join("your-amazing-game") 60 | .join("state"); 61 | ``` 62 | 63 | Time to create the primary window: 64 | 65 | ```rust 66 | app.world_mut().spawn(( 67 | PrimaryWindow, 68 | PersistentWindowBundle { 69 | window: Window { title: "I am the primary window!".to_owned(), ..Default::default() }, 70 | state: Persistent::::builder() 71 | .name("primary window state") 72 | .format(StorageFormat::Toml) 73 | .path(state_directory.join("primary-window.toml")) 74 | .default(WindowState::windowed(1280, 720)) 75 | .revertible(true) 76 | .revert_to_default_on_deserialization_errors(true) 77 | .build() 78 | .expect("failed to create the persistent primary window state"), 79 | }, 80 | )); 81 | ``` 82 | 83 | Feel free to spawn additional windows, without the `PrimaryWindow` component of course! 84 | 85 | Once, you're done, you can add `PersistentWindowsPlugin` plugin to the app: 86 | 87 | ```rust 88 | app.add_plugins(PersistentWindowsPlugin); 89 | ``` 90 | 91 | And run your game: 92 | 93 | ```rust 94 | app.run(); 95 | ``` 96 | 97 | You'll see a `1280x720` window appear in the center of your best monitor, move it around, resize, and play with it. Now close the application, and run it again. You'll see that the window will open in the exact same monitor, with the exact same resolution, and the exact same position! 98 | 99 | See [examples/setup.rs](https://github.com/umut-sahin/bevy-persistent-windows/blob/main/examples/setup.rs) for the full example! 100 | 101 | ### Controlling 102 | 103 | You may wish to control the persistent windows programmatically. You can edit the window itself, but if you want your changes to persist, you should modify the window state directly! 104 | 105 | Say you want to toggle fullscreen when space bar is pressed, you can add this system to your app: 106 | 107 | ```rust 108 | fn fullscreen_toggle( 109 | keyboard_input: Res>, 110 | mut query: Query<&mut Persistent, With>, 111 | ) { 112 | if keyboard_input.just_pressed(KeyCode::Space) { 113 | let mut primary_window_state = query.get_single_mut().unwrap(); 114 | 115 | if primary_window_state.mode == WindowMode::Windowed { 116 | primary_window_state.mode = WindowMode::Fullscreen; 117 | } else { 118 | primary_window_state.mode = WindowMode::Windowed; 119 | } 120 | 121 | primary_window_state.persist().ok(); 122 | } 123 | } 124 | ``` 125 | 126 | Or if you want to move the window with arrow keys, and resize it with ctrl + arrow keys, you can use this system: 127 | 128 | ```rust 129 | fn movement( 130 | time: Res