kyori-component-json 0.2.1

A library for serializing and deserializing Kyori Component JSON content
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# kyori-component-json

> Minecraft text formatting made easy

[![Crates.io](https://img.shields.io/crates/v/kyori-component-json.svg)](https://crates.io/crates/kyori-component-json)
[![Docs.rs](https://docs.rs/kyori-component-json/badge.svg)](https://docs.rs/kyori-component-json)
[![License](https://img.shields.io/badge/license-Apache--2.0%20OR%20MIT-blue.svg)](https://github.com/walker84837/kyori-component-json)

A simple Rust library for creating and working with Minecraft's JSON text components (Java Edition 1.21.5+). This is the same system used in commands like `/tellraw`, books, signs, and more!

## What can you do with this?

Mainly:
- Create tooling around Minecraft clients and [servers](https://jd.advntr.dev/text-serializer-json/4.23.0) easily
- Easier interop between Rust objects and Minecraft's text component format

But it also empowers you to:
- Create colorful chat messages with formatting (bold, italic, etc.)
- Add clickable text that runs commands when clicked
- Make hover text that shows extra information

### When would you use this?

1. **Command Generators**: Create `/tellraw` or `/title` commands programmatically
2. **Custom UIs**: Make interactive books or signs
3. **Data Packs**: Generate dynamic text components

## Simple Examples

### Basic Colored Text
```rust
use kyori_component_json::*;

let message = Component::text("Hello Minecraft!")
    .color(Some(Color::Named(NamedColor::Red)))
    .decoration(TextDecoration::Bold, Some(true));

// Use in /tellraw command:
// /tellraw @a {"text":"Hello Minecraft!","color":"red","bold":true}
```

### Clickable Text
```rust
let clickable = Component::text("Click me!")
    .click_event(Some(ClickEvent::RunCommand {
        command: "/say Hello!".into()
    }))
    .hover_event(Some(HoverEvent::ShowText {
        value: Component::text("This will run a command!")
    }));
```

### Combining Components
```rust
let combined = Component::text("Welcome, ")
    .append(
        Component::text("Player")
            .color(Some(Color::Named(NamedColor::Gold)))
    .append_newline()
    .append(clickable); // From previous example
```

## More Advanced Example

```rust
// Create a formatted message with multiple parts
let message = Component::text("Server Notice: ")
    .color(Some(Color::Named(NamedColor::Red)))
    .append(
        Component::text("Important update!")
            .color(Some(Color::Named(NamedColor::Gold)))
    .append_newline()
    .append(
        Component::text("Click for details")
            .click_event(Some(ClickEvent::RunCommand {
                command: "/update".into()
            }))
            .hover_event(Some(HoverEvent::ShowText {
                value: Component::text("Run /update command")
            }))
    );

// Convert to Minecraft JSON
let json = serde_json::to_string(&message).unwrap();
```

## Learning More

- [Minecraft Wiki: Raw JSON Text](https://minecraft.wiki/w/Raw_JSON_text_format)
- Library documentation: <https://docs.rs/kyori-component-json> or `cargo doc --open --no-deps`

## License

This project is licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

## Contribution

Contributions are welcome! Please feel free to submit a pull request.