Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 1.25 KB

README.md

File metadata and controls

29 lines (24 loc) · 1.25 KB
Raw

Introduction

This is a lightweight CLI-based version of Mechvibes. No Electron. Only supports Linux and Windows. (See why).

Features

  • Full support for themes made for the original Mechvibes.
  • Easy CLI interface.
    • mvibes run runs the app.
    • mvibes run --with active_theme.id=eg-oreo overrides the active theme specified in configuration.yml. You can override any option in the file using this option. You are allowed to use this option multiple times like this: mvibes run --with key1.sub_key1=value --with key2.sub_key2=value.
    • See mvibes --help for more information.
  • Default themes same as the original Mechvibes, see themes.

Instructions to Install

See the wiki page for instructions to install.

Usage

See the wiki page for a guide to using this project.

Configuration

Configuration is done in the configuration.yml file. See the wiki page for documentation.

Contributing

Thank you for your interest. Please see CONTRIBUTING.md.

License

This project is licensed under the MIT license.