bevy_easy_localize 0.6.0

Lightweight localization in bevy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# `bevy_easy_localize`

[![Crates.io](https://img.shields.io/crates/v/bevy_easy_localize)](https://crates.io/crates/bevy_easy_localize)

A simple crate to localize your game using .csv files.
## Features

- Loading from `.csv` files
- Loading the translation file from the asset folder
- Automatically updating text components
- Hot reloading
- Lightweight
## Upcoming features
- Per-language fonts
- More flexible and customizable `.csv` file loading
## How to use
The `.csv` file currently must be arranged in this order:

|Keyword|Comments|Language_0|Language_1|...|
|---|---|---|---|---|
|word|comment|translation0|translation1|...|

![image](https://user-images.githubusercontent.com/50209404/209450226-0362a4b5-4b26-47ad-adc0-90fa2f902ef3.png)

In your project:
```rust
use bevy::prelude::*;
use bevy_easy_localize::Localize;
pub fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(bevy_easy_localize::LocalizePlugin)
        //Insert the resource from an asset path
        .insert_resource(Localize::from_asset_path("translations.csv"))
        .add_systems(Startup, translate)
        .run();
}
fn translate(
    keyboard:Res<ButtonInput<KeyCode>>,
    mut localize:ResMut<Localize>,
){
    //Easily set the language
    localize.set_language("German");
    if keyboard.just_pressed(KeyCode::Space){
        //Use the get() method to get a translated word for the specified keyword
        println!("{}",localize.get("start_game"));
    }
}
```
Using the `LocalizeText` component:
```rust
commands.spawn((
    TextBundle::from_section(
        "default value",
        TextStyle {
            font: asset_server.load("font.ttf"),
            font_size: 100.0,
            color: Color::WHITE,
        },
    ),
    //add this component to automatically translate text
    LocalizeText::from_section("my_keyword")
));
```
## Examples

- [`simple`](examples/simple.rs) – Reading from a file to initialize the resource.
- [`asset`](examples/asset.rs) – Using asset handles to initialize the resource.
- [`text`](examples/text.rs) – Using the `LocalizeText` component to update text.
- [`sys_locale`](examples/sys_locale.rs) - Using the crate `sys-locale` to set the default language.
## Bevy Compatibility
|bevy|bevy_easy_localize|
|---|---|
|0.14|0.6|
|0.13|0.5|
|0.12|0.4|
|0.11|0.3|
|0.10|0.2|
|0.9|0.1|
## About
I made this crate for my personal projects. 
The obvious alternative is [`bevy_fluent`](https://github.com/kgv/bevy_fluent), but my goal is to just translate some text and 
I don't need all of the fancy features it offers.
I will definitely be updating this crate and if you want to add a feature, please submit a pull request.