Skip to content

Commit

Permalink
Make secondary text color a parameter instead of messing with alpha. …
Browse files Browse the repository at this point in the history
…Add theme examples
  • Loading branch information
nickavv committed Sep 12, 2020
1 parent 7504b14 commit 9b161fb
Show file tree
Hide file tree
Showing 14 changed files with 234 additions and 106 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@ The following variables on the `obj_shell` object can be customized. They are de
| `width` | The width, in GUI pixels, of the shell | 500 |
| `height` | The height, in GUI pixels, of the shell | 96 |
| `prompt` | A character or string to print as a command prompt | $ |
| `promptColor` | The font color to draw the prompt, as a GML expression | `c_red` |
| `promptColor` | The font color to draw the prompt, as a GML expression | `make_color_rgb(237, 0, 54)` |
| `openKey` | The key that opens the console, in combination with the `modifierKeys` if any. Must be a valid character that can be decoded with [`ord()`](https://docs2.yoyogames.com/source/_build/3_scripting/4_gml_reference/strings/ord.html) (typically the capital letters) | C |
| `modifierKeys` | A multi-select of special keys. All the selected keys must be pressed in combination with `openKey` to open the console | `vk_control`, `vk_shift` |
| `consoleColor` | The background color of the console itself, as a GML expression | `c_black` |
| `consoleAlpha` | The opacity of the console itself, 0.0 being fully transparent and 1.0 being fully opaque | 0.9 |
| `consoleFont` | The GML font resource to draw all the console text with. The default is included with the package, and uses the Microsoft "Consolas" font | `font_console` |
| `fontColor` | The font color to draw all console text with, as a GML expression | `c_white` |
| `consoleFont` | The GML font resource to draw all the console text with. The default is included with the package, and uses the Raph Levien's "Inconsolata" font | `font_console` |
| `fontColor` | The font color to draw all console text with, as a GML expression | `make_color_rgb(255, 242, 245)` |
| `fontColorDark` | The font color to draw suggestions and history with, as a GML expression | `make_color_rgb(140, 118, 123)` |
| `screenAnchorPoint` | The location on the screen to anchor the console to, as a string. Possible values are `"top"` or `"bottom"`. | `"bottom"` |

You can see examples of various customizations on the [Theme Gallery](THEMING.md) page!

## Writing Your Own Shell Scripts

Expand Down
70 changes: 70 additions & 0 deletions THEMING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Theme Gallery
rt-shell is customizable in a number of ways. On this page you can see a variety of
themes created using the available customization options.

Come up with your own great theme, and want it featured here? Get in touch on [Twitter](https://twitter.com/daikonsoftware)!

<table>
<tr>
<td>
<b>rt-shell-dark</b><br>
<img src="images/theme-rtshell-dark.png" width="500" alt="rt-shell-dark theme" /><br><br>
The default rt-shell theme<br>
<pre><code>obj_shell.consoleAlpha = 0.9;
obj_shell.consoleColor = c_black;
obj_shell.fontColor = make_color_rgb(255, 242, 245);
obj_shell.fontColorDark = make_color_rgb(140, 118, 123);
obj_shell.promptColor = make_color_rgb(237, 0, 54);
obj_shell.prompt = "$";</code></pre><br>
<td>
<b>rt-shell-light</b><br>
<img src="images/theme-rtshell-light.png" width="500" alt="rt-shell-light theme" /><br><br>
A light version of the default rt-shell theme<br>
<pre><code>obj_shell.consoleAlpha = 0.9;
obj_shell.consoleColor = make_color_rgb(235, 235, 235);
obj_shell.fontColor = make_color_rgb(40, 40, 45);
obj_shell.fontColorDark = make_color_rgb(120, 120, 128);
obj_shell.promptColor = make_color_rgb(29, 29, 196);
obj_shell.prompt = "$";</code></pre><br>
<tr>
<td>
<b>ocean-blue</b><br>
<img src="images/theme-ocean-blue.png" width="500" alt="ocean-blue theme" /><br><br>
A cobalt gray and ocean blue theme<br>
<pre><code>obj_shell.consoleAlpha = 1;
obj_shell.consoleColor = make_color_rgb(29, 31, 33);
obj_shell.fontColor = make_color_rgb(197, 200, 198);
obj_shell.fontColorDark = make_color_rgb(116, 127, 140);
obj_shell.promptColor = make_color_rgb(57, 113, 237);
obj_shell.prompt = "%";</code></pre><br>
<td>
<b>dracula</b><br>
<img src="images/theme-dracula.png" width="500" alt="dracula theme" /><br><br>
The popular <a href="https://draculatheme.com/">Dracula theme</a>!<br>
<pre><code>obj_shell.consoleAlpha = 1;
obj_shell.consoleColor = make_color_rgb(40, 42, 54);
obj_shell.fontColor = make_color_rgb(248, 248, 242);
obj_shell.fontColorDark = make_color_rgb(98, 114, 164);
obj_shell.promptColor = make_color_rgb(80, 250, 123);
obj_shell.prompt = "->";</code></pre><br>
<tr>
<td>
<b>solarized-dark</b><br>
<img src="images/theme-solarized-dark.png" width="500" alt="solarized-dark theme" /><br><br>
The popular <a href="https://ethanschoonover.com/solarized/">Solarized Dark theme</a>!<br>
<pre><code>obj_shell.consoleAlpha = 1;
obj_shell.consoleColor = make_color_rgb(0, 43, 54);
obj_shell.fontColor = make_color_rgb(131, 148, 150);
obj_shell.fontColorDark = make_color_rgb(88, 110, 117);
obj_shell.promptColor = make_color_rgb(42, 161, 152);
obj_shell.prompt = "~";</code></pre><br>
<td>
<b>solarized-light</b><br>
<img src="images/theme-solarized-light.png" width="500" alt="solarized-light theme" /><br><br>
The popular <a href="https://ethanschoonover.com/solarized/">Solarized Light theme</a>!<br>
<pre><code>obj_shell.consoleAlpha = 1;
obj_shell.consoleColor = make_color_rgb(253, 246, 227);
obj_shell.fontColor = make_color_rgb(101, 123, 131);
obj_shell.fontColorDark = make_color_rgb(147, 161, 161);
obj_shell.promptColor = make_color_rgb(42, 161, 152);
obj_shell.prompt = "~";</code></pre><br>
Binary file added images/theme-dracula.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/theme-ocean-blue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/theme-rtshell-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/theme-rtshell-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/theme-solarized-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/theme-solarized-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified rt-shell/fonts/font_console/font_console.old.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 9b161fb

Please sign in to comment.