├── .github ├── FUNDING.yml └── workflows │ └── ci.yml ├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── assets └── demo.gif ├── examples └── cli_print.rs └── src ├── android.rs ├── apple.rs ├── lib.rs └── windows.rs /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: rustunit -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | schedule: 5 | - cron: '0 2 * * *' 6 | push: 7 | branches: [ '*' ] 8 | 9 | env: 10 | CARGO_TERM_COLOR: always 11 | 12 | jobs: 13 | build: 14 | strategy: 15 | matrix: 16 | os: [ubuntu-latest, macos-latest, windows-latest] 17 | rust: [nightly, stable] 18 | runs-on: ${{ matrix.os }} 19 | 20 | steps: 21 | - uses: actions/checkout@v4 22 | - uses: dtolnay/rust-toolchain@stable 23 | 24 | - name: Rust Cache 25 | uses: Swatinem/rust-cache@v2 26 | 27 | - name: Cargo Check 28 | run: cargo c 29 | 30 | - name: Cargo Build 31 | run: cargo b 32 | 33 | - name: Cargo Build Release 34 | run: cargo b --release 35 | 36 | - name: Cargo Clippy 37 | run: cargo clippy -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | Cargo.lock -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "bevy_device_lang" 3 | version = "0.6.0" 4 | edition = "2021" 5 | readme = "README.md" 6 | license = "MIT" 7 | authors = ["extrawurst "] 8 | documentation = "https://docs.rs/bevy_device_lang" 9 | repository = "https://github.com/rustunit/bevy_device_lang" 10 | keywords = ["bevy", "gamedev", "mobile", "crossplatform"] 11 | description = "Crossplatform way to query device language setting" 12 | 13 | [package.metadata.docs.rs] 14 | default-target = "x86_64-apple-darwin" 15 | 16 | [target.'cfg(any(target_os = "ios", target_os = "macos"))'.dependencies] 17 | objc2-foundation = { version = "0.3", features = [ 18 | "NSLocale", 19 | "NSArray", 20 | "NSString", 21 | ] } 22 | objc2 = { version = "0.6", features = ["relax-sign-encoding"] } 23 | 24 | [target.'cfg(target_os = "android")'.dependencies] 25 | jni = "0.21" 26 | ndk-context = "0.1" 27 | 28 | [target.'cfg(target_family = "wasm")'.dependencies.web-sys] 29 | version = "0.3" 30 | features = ["Navigator", "Window"] 31 | 32 | [target.'cfg(target_os = "windows")'.dependencies] 33 | windows = { version = "0.58", features = [ 34 | "Win32_Globalization", 35 | "Win32_System_SystemServices", 36 | ] } 37 | -------------------------------------------------------------------------------- /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 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all 11 | copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # bevy_device_lang 2 | 3 | [![crates.io][sh_crates]][lk_crates] 4 | [![docs.rs][sh_docs]][lk_docs] 5 | [![discord][sh_discord]][lk_discord] 6 | 7 | [sh_crates]: https://img.shields.io/crates/v/bevy_device_lang.svg 8 | [lk_crates]: https://crates.io/crates/bevy_device_lang 9 | [sh_docs]: https://img.shields.io/docsrs/bevy_device_lang 10 | [lk_docs]: https://docs.rs/bevy_device_lang/latest/bevy_device_lang/ 11 | [sh_discord]: https://img.shields.io/discord/1176858176897953872?label=discord&color=5561E6 12 | [lk_discord]: https://discord.gg/rQNeEnMhus 13 | 14 | Provides access device language cross-platform: iOS, Android, Web (Wasm), Windows & Linux. 15 | Useful to support app localization in the right language. 16 | 17 | See the crate in action in [Zoolitaire](www.zoolitaire.com): 18 | 19 | ![demo](./assets/demo.gif) 20 | 21 | ## Features 22 | * macOS, iOS (using `[NSLocale preferredLanguage]` see [docs](https://developer.apple.com/documentation/foundation/nslocale/1415614-preferredlanguages)) 23 | 24 | * Android (using `Locale.getDefault().toLanguageTag` see [docs](https://developer.android.com/reference/java/util/Locale#toLanguageTag())) 25 | * Wasm (uses `web-sys` and `Navigator.language()` see [docs](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language)) 26 | * Windows (using `GetUserDefaultLocaleName` see [docs](https://learn.microsoft.com/en-us/windows/win32/api/winnls/nf-winnls-getuserdefaultlocalename)) 27 | * Linux (using Env: `LC_ALL`, `LC_MESSAGES` or `LANG`) 28 | 29 | ## Usage 30 | 31 | Add dependency: `bevy_device_lang = "0.4"` 32 | 33 | ```rust 34 | fn bevy_system() { 35 | let lang : Option = bevy_device_lang::get_lang(); 36 | } 37 | ``` 38 | 39 | ## Our Other Crates 40 | 41 | - [bevy_debug_log](https://github.com/rustunit/bevy_debug_log) 42 | - [bevy_device_lang](https://github.com/rustunit/bevy_device_lang) 43 | - [bevy_web_popups](https://github.com/rustunit/bevy_web_popups) 44 | - [bevy_libgdx_atlas](https://github.com/rustunit/bevy_libgdx_atlas) 45 | - [bevy_ios_review](https://github.com/rustunit/bevy_ios_review) 46 | - [bevy_ios_gamecenter](https://github.com/rustunit/bevy_ios_gamecenter) 47 | - [bevy_ios_alerts](https://github.com/rustunit/bevy_ios_alerts) 48 | - [bevy_ios_notifications](https://github.com/rustunit/bevy_ios_notifications) 49 | - [bevy_ios_impact](https://github.com/rustunit/bevy_ios_impact) 50 | - [bevy_ios_safearea](https://github.com/rustunit/bevy_ios_safearea) 51 | 52 | # License 53 | 54 | All code in this repository is dual-licensed under either: 55 | 56 | - MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT) 57 | - Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) 58 | 59 | at your option. This means you can select the license you prefer. 60 | 61 | ## Your contributions 62 | Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. 63 | -------------------------------------------------------------------------------- /assets/demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rustunit/bevy_device_lang/6a5b1553550ca4477e9a50e4bf0aeae64a38a720/assets/demo.gif -------------------------------------------------------------------------------- /examples/cli_print.rs: -------------------------------------------------------------------------------- 1 | fn main() { 2 | println!("{:#?}", bevy_device_lang::get_lang()); 3 | } 4 | -------------------------------------------------------------------------------- /src/android.rs: -------------------------------------------------------------------------------- 1 | use jni::{self, objects::JString}; 2 | 3 | /// uses `Locale.getDefault().toLanguageTag()` [docs](https://developer.android.com/reference/java/util/Locale#toLanguageTag()) 4 | pub fn lang_android() -> Option { 5 | let ctx = ndk_context::android_context(); 6 | let vm = unsafe { jni::JavaVM::from_raw(ctx.vm().cast()) }.ok()?; 7 | let mut env = vm.attach_current_thread().ok()?; 8 | let class = env.find_class("java/util/Locale").ok()?; 9 | let locale = env 10 | .call_static_method(class, "getDefault", "()Ljava/util/Locale;", &[]) 11 | .ok()? 12 | .l() 13 | .ok()?; 14 | 15 | let lang: JString = env 16 | .call_method(locale, "toLanguageTag", "()Ljava/lang/String;", &[]) 17 | .ok()? 18 | .l() 19 | .ok()? 20 | .into(); 21 | 22 | let lang = env.get_string(&lang).ok()?; 23 | let lang: String = lang.into(); 24 | Some(lang) 25 | } 26 | -------------------------------------------------------------------------------- /src/apple.rs: -------------------------------------------------------------------------------- 1 | /// returns first language from `[NSLocale preferredLanguages]` 2 | /// (see [docs](https://developer.apple.com/documentation/foundation/nslocale/1415614-preferredlanguages)) 3 | pub fn lang_apple() -> Option { 4 | use objc2_foundation::NSLocale; 5 | 6 | let lang = unsafe { NSLocale::preferredLanguages().iter().next()?.to_string() }; 7 | 8 | Some(lang.to_string()) 9 | } 10 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #[cfg(target_os = "android")] 2 | mod android; 3 | 4 | #[cfg(any(target_os = "macos", target_os = "ios"))] 5 | mod apple; 6 | 7 | #[cfg(target_os = "windows")] 8 | mod windows; 9 | 10 | /// return language code like "en-US", "en-UK" or two letter ones like "en", "de" 11 | #[cfg(any(target_os = "macos", target_os = "ios"))] 12 | pub fn get_lang() -> Option { 13 | crate::apple::lang_apple() 14 | } 15 | 16 | #[cfg(target_os = "android")] 17 | pub fn get_lang() -> Option { 18 | crate::android::lang_android() 19 | } 20 | 21 | #[cfg(target_family = "wasm")] 22 | pub fn get_lang() -> Option { 23 | web_sys::window().and_then(|w| w.navigator().language()) 24 | } 25 | 26 | #[cfg(target_os = "linux")] 27 | pub fn get_lang() -> Option { 28 | if let Ok(value) = std::env::var("LC_ALL") 29 | .or_else(|_| std::env::var("LC_MESSAGES")) 30 | .or_else(|_| std::env::var("LANG")) 31 | { 32 | Some(value.split('.').next().unwrap_or(&value).into()) 33 | } else { 34 | None 35 | } 36 | } 37 | 38 | #[cfg(target_os = "windows")] 39 | pub fn get_lang() -> Option { 40 | crate::windows::lang_windows() 41 | } 42 | -------------------------------------------------------------------------------- /src/windows.rs: -------------------------------------------------------------------------------- 1 | use std::ffi::OsString; 2 | use std::os::windows::ffi::OsStringExt; 3 | use windows::Win32::Globalization::GetUserDefaultLocaleName; 4 | use windows::Win32::System::SystemServices::LOCALE_NAME_MAX_LENGTH; 5 | 6 | pub fn lang_windows() -> Option { 7 | unsafe { 8 | let mut buffer: [u16; LOCALE_NAME_MAX_LENGTH as usize] = 9 | [0; LOCALE_NAME_MAX_LENGTH as usize]; 10 | if GetUserDefaultLocaleName(&mut buffer) != 0 { 11 | let len = buffer.iter().position(|&c| c == 0).unwrap_or(buffer.len()); 12 | let locale_name = OsString::from_wide(&buffer[..len]); 13 | if let Ok(result) = locale_name.into_string() { 14 | return Some(result); 15 | } 16 | } 17 | } 18 | None 19 | } 20 | --------------------------------------------------------------------------------