Skip to content

README.md

Latest commit

 

History

History
64 lines (44 loc) · 1.4 KB

README.md

File metadata and controls

64 lines (44 loc) · 1.4 KB
Raw

Kaguya

Description

icon

Linux game saves and configurations backup manager for CLI enjoyers.

Quick Start

  • Default global config: $XDG_CONFIG_HOME/kaguya/config.toml
  • Default vault dir: $XDG_DATA_HOME/kaguya/vault
  • Default vault config: $XDG_DATA_HOME/kaguya/vault/vault.toml
# Add a game to kaguya vault config
kaguya config add --id game-a --paths test-games/game-a/config.json

# List all the games in vault config
kaguya config list [-l/--long]

# Backup action
kaguya vault backup

# Restore
# Use latest version if '--version' is not provided
kaguya vault restore --id <ID> [--version <VERSION>] [--paths <PATH1> [<PATH2>...]]

Installation

From source

From crate.io

cargo install kaguya

From local source

git clone https://github.com/AllenWu233/kaguya
cd kaguya
cargo install --path .

Uninstallation

cargo uninstall kaguya

Todo

  • Implement backup pruning mechanism
  • Global configuration support (config.toml)
  • Additional compression formats (e.g., .zip)
  • TUI interface (kaguya-tui)
  • Auto-discovery for Steam and Epic games