Adding `vn_settings` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add vn-settings

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

vn-settings = "0.2.0"

The vn_settings library will be automatically available globally. Read the vn_settings library documentation.

Back to the crate overview.

Readme

Visual Novel settings

A cross-platform configuration system for visual novels, featuring cascading overrides and real-time state management.

Overrides

This library provides various settings to simulate visual novels in Rust applications. It includes settings for colors, timing, images, objects, layout, and names.

Each parameter can have a default value and you can add temporary overrides to these values, which will only be active during a single continuous dialog.

Most parameters can also have a character specific values, which are only set when a character speaks. These character specific parameters can also have temporary overrides.

The priorities of the values is like this:

General scene value (scene)
General character specific scene value (characters_scene)
General character specific default value (characters_default)
General default value (default)

This should make managing state for visual novels easy.

Features

🎨 Cascading Settings

Override colors, timing, and layouts at multiple levels:

settings.set_character_default(Setter::Color(
    ColorParameter::Dialog(BoxColorParameter::TextFill).named("Alice"),
    Color::RED
));

🔄 State Management

Track defaults, character-specific overrides, and scene changes:

settings.change(&Change::Timing(
    TimingParameter::AutoNext.named("FastMode"),
    1.0
));

📦 Serialization Ready

All types implement serde::Serialize (enable serde feature).

Core Types

Type	Description
`PlayerSettings`	Root container for all configuration
`Override<T>`	Hierarchical value management
`Parameter`	Addressable setting path
`Change`	Mutation operation

Documentation

API Reference

Developed with ❤️ for visual novel creators

Adding vn_settings library as a dependency

Adding `vn_settings` library as a dependency