Giter VIP home page Giter VIP logo

mxcolr-v2's Introduction

mxcolr-v2 ▲

Features

  • Pseudo Random Palette Generation
  • Live terminal preview currently only for alacritty / tmux
  • Template parsing and Variable Replacement
  • Plugin mechanics for advance usage

Usage

chmod +x mxcolr
mxcolr [-s <vivid|lch>] [-i]

-s  | (Pastel randomization strategy) default is vivid
-i  | interactive mode

every file in ./templates/{tpl} will be parsed;

scheme variables replaced; and placed in ./out/{tpl}

generate

SBG, WBG, EBG are trio of randomely generated colors, they are the core of the palette

Given the same seed, its guaranteed the same scheme file be produced.

Possible variables available in all templates or plugins are:

C00 C01 C02 C03 C04 C05 C06 C07 C08 C09 C10 C11 C12 C13 C14 C15
    CX1 CX2 CX3 CX4 CX5 CX6 # extra saturated
    CY1 CY2 CY3 CY4 CY5 CY6 # extra desaturated
    CF1 CF2 CF3 CF4 CF5 CF6 # fg color on CX bg

SBG WBG EBG # seed bg colors
SFG WFG EFG # seed fg colors

SK0 SK1 SK2 SK3 SK4 SK5 SK6 SK7 SK8 SK9 # S shades
WK0 WK1 WK2 WK3 WK4 WK5 WK6 WK7 WK8 WK9 # W shades
EK0 EK1 EK2 EK3 EK4 EK5 EK6 EK7 EK8 EK9 # E shades

XBG # main bg colors
XFG # main fg colors

Advance Usage

if further steps required to patch an app a plugin sh file can be added to plugins folder to make the additinal steps

each sh file presents in ./plugins folder is treated as a plugin and is sourced

its expected to follow these patterns:

  • filename: [0-9]-[a-z_].sh eg 1-vim.sh
    • prefix number is the order its loaded, 0 means disabled
    • suffix the plugin_name
  • plugin file is expected to have a function named apply this function will be called with confirmation prompt

current active loaded theme variables are available to plugin

all templates if any are parsed before calling apply_ function

plugins outputs will first be drafted in /tmp/mxc and later upon confirmation prompt moved to ~/.config/mxc-v2/{plugin_name} unless different destination is set

Motivations

While tools like Oomox and Spicetify are great in reallity you probably got more than GTK theme and Icons you'd want to patch

Terminal colors, terminal prompt, window manager / status bar theme / icons, Vim/Atom/SourceCode editor and more

Some apps might require to compile and build, all of these are just too repetitive and anoying to do for every change, then there is the never ending search for the right color scheme

What about

  • Pywal: all about Wallpaper,, great documentation and support though.

almost all pywal-customization can be easilly added

  • Oomox plugins: possible,, to mxcolr, oomox is just another plugin for gtk theme and icon

This repo goal is to be a tool for generating and previewing palettes and serve as a framework for patching any application with few keystrokes.

Requirements

this project is the version 2 of mxcolr

V2 Roadmap

  • plugin mechanics
  • live preview* alacritty only
  • interactive mode
  • snapshots
  • demos

Similar projects

  • xi/xiwal Generate terminal color schemes -- python
  • piutranq/cologen The simple color scheme configuration generator, inspired by base16-builder. -- rust
  • kumux/kumux-colorscheme-engine Kumux is the world's first dynamic circadian color scheme for code editors and other software. -- javascript
  • dylanaraps/pywal Generate and change color-schemes on the fly. -- python
  • themix-project/oomox Graphical application for generating different color variations of a Materia and Oomox themes -- python
  • spicetify/spicetify-cli Commandline tool to customize Spotify client -- javascript

mxcolr-v2's People

Contributors

metaory avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.