Skip to content

BenjaminKalb Localizations Markup Language File Finder is a cross—platform CLI file search tool for .bklml files (BKLML — localization files).

License

Notifications You must be signed in to change notification settings

BenjaminKalb/bklml_ff

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

BKLML File Finder

License: GPL v3 Python 3.8+

BenjaminKalb Localizations Markup Language File Finder — cross-platform CLI scanner for .bklml files (BKLML localizations).

✨ Features

  • 🔍 Recursive search for .bklml files in folders
  • 📊 Metadata parsing: @VERSION:{1.2.0} and @DESCRIPTION:{text}
  • 💻 Full cross-platform: Linux, Windows, macOS
  • Without dependencies — Python standard library only
  • 📦 Easy installation: AUR, PyPI, pipx or manual (AUR, PyPI, pipx in the next update)

🚀 Quick Start

Installation

Arch Linux (AUR):

yay -S bklml_ff
# or
paru -S bklml_ff

Any system (PyPI):

pipx install git+https://github.com/benjaminkalb/bklml_ff.git
pip install bklml-ff

Manual installation:

git clone https://github.com/benjaminkalb/bklml_ff.git
cd bklml_ff
chmod +x bklml_ff.py
sudo cp bklml_ff.py /usr/local/bin/bklml_ff  # Linux/Mac
# Windows: rename to bklml_ff.py & add to PATH

⚡ Usage

Help

bklml_ff --help

Search in the current folder

bklml_ff .

Recursive search with details

bklml_ff ~/projects --details

Only the upper level

bklml_ff /path/to/folder --no-recursive -d

📊 Example of output from --details

Found 3 .bklml file(s):

File path                           | Version  | Description
----------------------------------------------------------------------
src/en.bklml                        | 1.2.0    | English 2D Game Localization
src/ru.bklml                        | 1.1.1    | Russian 2D Game Localization
plugins/auth.bklml                  | 0.9.2    | translations for lines

📋 Command Line arguments

> Argument | > Description | > Example

= = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

DIRECTORY	| The folder to scan (by default .)	| bklml_ff ~/src
--details, -d	| Show versions and descriptions | --details
--no-recursive | Only the upper level	| --no-recursive
--version	| Program version	| --version
--help, -h	| Reference	| --help

🤝 Contribution to the development

[1] Fork repository
[2] Create branch: git checkout -b feature/amazing-feature
[3] Commit changes: git commit -m 'Add amazing feature'
[4] Push to the branch: git push origin feature/amazing-feature
[5] Create Pull Request

About

BenjaminKalb Localizations Markup Language File Finder is a cross—platform CLI file search tool for .bklml files (BKLML — localization files).

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages