Dahlia.rs

A Rust implementation of Dahlia — a simple text formatting package, inspired by the game Minecraft.

Text is formatted similarly to in the game. With Dahlia, it is formatted by typing a marker (& by default, but any other char is allowed) followed by a format code and finally the text to be formatted.

Usage

Add this to your Cargo.toml:

[dependencies]
dahlia = "2.0"

Import and use like this:

use dahlia::{Dahlia, dprintln};

fn main() {
  let dahlia = Dahlia::default().with_auto_depth();

  // Print "Hello, world!" in green bold with "world!" underlined
  let formatted = dahlia.convert("&2&lHello, &nworld!");

  // Convenience macro to print text with println! like syntax
  let name = "David";
  dprintln!(dahlia, "&2Hello, {name}!"); // green "Hello, David!"

  // Remove formatting from the text with `clean`
  assert_eq!(dahlia.clean("&2Hello, &lworld!"), "Hello, world!");

  // Use `_` to escape the marker
  assert_eq!(dahlia.convert("&_2Hello!"), "&2Hello!");
}

The code documentation is available at docs.rs, for more detailed information about available formatting and other features, see the specification.

Short summary:

Color Format Codes

Each digit/letter corresponds to a hex value (dependent on the color depth). The coloring can be applied to the background if a ~ is inserted between & and the code.

Formatting Codes

Custom Colors

To specify colors by hex code follow the marker with CSS-like hex color syntax.

• Foreground: &#xxx; or &#xxxxxx;
• Background: &~#xxx; or &~#xxxxxx;

Note: x here represents a hex digit.

License

dahlia-rs is licensed under the MIT License.