diff options
| author | Devine Lu Linvega <aliceffekt@gmail.com> | 2018-09-14 10:08:37 +1200 |
|---|---|---|
| committer | Devine Lu Linvega <aliceffekt@gmail.com> | 2018-09-14 10:08:37 +1200 |
| commit | c9c4d4fbb5e4cfbf3affb83603df9629c344c227 (patch) | |
| tree | 417ccb73145569f151d099c117c6ca7ec3b74293 /README.md | |
| parent | 056862e775375f26d21470a17afdae6ac53695ce (diff) | |
Updated README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 152 |
1 files changed, 48 insertions, 104 deletions
@@ -1,113 +1,57 @@ # Themes -This collection of themes are meant to be used with [Marabu](https://github.com/hundredrabbits/Marabu), [Ronin](https://github.com/hundredrabbits/Ronin), [Left](https://github.com/hundredrabbits/Left), [Donsol](https://github.com/hundredrabbits/Donsol) and [Dotgrid](https://github.com/hundredrabbits/Dotgrid). -This collection may also be used with -[Tape](https://aeriform.itch.io/tape) by Aeriform. +This repo documents the specs of the theme format used across the Hundred Rabbits' [ecosystem](https://github.com/hundredrabbits). You can also implement the theme support into your own apps. See the [Collection](COLLECTION.md) for all available themes. <img src='https://raw.githubusercontent.com/hundredrabbits/Themes/master/PREVIEW.jpg' width='600'/> -## Install -To install a theme, simply drag the `thm` file onto the application window. -You are welcome to submit your own themes to this collection! - -## [2b](themes/2b.thm) - - -## [apollo](themes/apollo.thm) - - -## [apollo11](themes/apollo11.thm) - - -## [ash](themes/ash.thm) - - -## [battlestation](themes/battlestation.thm) - - -## [berry](themes/berry.thm) - - -## [blanc](themes/blanc.thm) - - -## [cina](themes/cina.thm) - - -## [coal](themes/coal.thm) - - -## [commodore](themes/commodore.thm) - - -## [cpc](themes/cpc.thm) - - -## [deuveir](themes/deuveir.thm) - - -## [donsol](themes/donsol.thm) - - -## [frameio](themes/frameio.thm) - - -## [gameboy](themes/gameboy.thm) - +## Specs + +``` +{ + "meta": { + "author": "aeriform", + "version": 2, + "revision": 1 + }, + "data": { + "background": "#d4d3c0", + "b_high": "#ede6d4", + "b_med": "#534e41", + "b_low": "#dfddca", + "b_inv": "#cc295c" + "f_high": "#534e41", + "f_med": "#534e41", + "f_low": "#ede6d4", + "f_inv": "#cc295c", + } +} +``` + +### Usage + +To implement support, you need to add the [theme.js](https://github.com/hundredrabbits/Dotgrid/blob/master/desktop/sources/scripts/lib/theme.js), and the [theme.css](https://github.com/hundredrabbits/Dotgrid/blob/master/desktop/sources/links/theme.css). The CSS is where the style is applies onto the html elements. + +- `background`, Background, general. +- `f_high`, Foreground, high-contrast. +- `f_med`, Foreground, medium-contrast. +- `f_low`, Foreground, low-contrast. +- `f_inv`, Foreground, inverted. +- `f_high`, Background, high-contrast. +- `f_med`, Background, medium-contrast. +- `f_low`, Background, low-contrast. +- `f_inv`, Background, inverted. + +## Supported Applications + +- [Marabu](https://github.com/hundredrabbits/Marabu), music tool. +- [Left](https://github.com/hundredrabbits/Left), writing tool. +- [Dotgrid](https://github.com/hundredrabbits/Dotgrid), vector tool. +- [Donsol](https://github.com/hundredrabbits/Donsol), card game. -## [lotus](themes/lotus.thm) - - -## [mahou](themes/mahou.thm) - - -## [marble](themes/marble.thm) - - -## [merveilles](themes/merveilles.thm) - - -## [noir](themes/noir.thm) - - -## [pale](themes/pale.thm) - - -## [pico8](themes/pico8.thm) - - -## [ramma](themes/ramma.thm) - - -## [raspberry](themes/raspberry.thm) - - -## [robo](themes/robo.thm) - - -## [solitaire](themes/solitaire.thm) - - -## [seaweed](themes/seaweed.thm) - - -## [snow](themes/snow.thm) - - -## [soft](themes/soft.thm) - - -## [soyuz](themes/soyuz.thm) - - -## [swiss](themes/swiss.thm) - +This collection may also be used with +[Tape](https://aeriform.itch.io/tape) by Aeriform. -## [tape](themes/tape.thm) - +## Extras -## [tape_se](themes/tape_se.thm) - +You are welcome to submit your own themes to this collection! -## [toxik](themes/toxik.thm) - |
