Themes Creator

About

A script that creates and debug theme files based on templates, specially for terminal emulators. It already comes bundled with some templates.

Installation

Dependencies

In order to install and run this software properly, the following dependencies must be installed:

• git: required to clone this repository.
• ruby: required to run the script.

Procedures

• Clone this repository using git.

git clone --depth 1 https://github.com/skippyr/themes-creator

• Access the repository's directory.

cd themes-creator

Usage

Creating A Theme From Template

• Create a file based on the metadata.template file in which you will store the metadata of your theme. The lines of that file must follow this convention.

  Line Number	Description
  1	The name of the theme.
  2	The author of the theme.
  3	The license the theme is under.
  4	The URL where the theme will be distributed.
  5	Color of ANSI 0 (black) (used as background).
  6	Color of ANSI 1 (red).
  7	Color of ANSI 2 (green).
  8	Color of ANSI 3 (yellow).
  9	Color of ANSI 4 (blue).
  10	Color of ANSI 5 (magenta).
  11	Color of ANSI 6 (cyan).
  12	Color of ANSI 7 (white) (used as foreground).

  ANSI colors are the reference to create terminal emulator themes. The colors must be in HEX format, starting with the hashtag, #, character and without opacity attributes. Their case does not matter. For example: #ff0000 is a valid one.

• Take a look inside of the templates directory and choose a template for you to use. Each one of them create a theme for one application. Alternatively, you can use a custom one that you have created.

• Use the script passing the paths to your metadata and template files as arguments. For example, you can create a theme for Kitty using the metadata.template file just to test it.

ruby themes-creator metadata.template templates/kitty.template

Creating A Template

You can create your own templates to create more themes. For that, simply write a file possibly containing the following placeholders:

Placeholder	Replaced By
~%{name}%~	The name of the theme.
~%{author}%~	The author of the theme.
~%{license}%~	The license the theme is under.
~%{url}%~	The URL where the theme will be distributed.
~%{black}%~	Color of ANSI 0 (black) (used as background).
~%{red}%~	Color of ANSI 1 (red).
~%{green}%~	Color of ANSI 2 (green).
~%{yellow}%~	Color of ANSI 3 (yellow).
~%{blue}%~	Color of ANSI 4 (blue).
~%{magenta}%~	Color of ANSI 5 (magenta).
~%{cyan}%~	Color of ANSI 6 (cyan).
~%{white}%~	Color of ANSI 7 (white) (used as foreground).

After creating it, you can start using it with the script and a metadata file.

If you need some references, you can always take a look in the source code of the templates under the template directory to see how they look like.

Testing Terminal Emulator Themes

You can test your current terminal emulator theme by running the script with the --preview option:

ruby themes-creator --preview

Help Page

Access its help page by running it using the --help options. There you will find instructions on how to use it, available options and their descriptions.

ruby themes-creator --help

Support

Report issues, questions and suggestions through its issues page.

Copyright

This software is under the MIT license. A copy of the license is bundled with the source code.