diff --git a/README.md b/README.md index 3a2cc7c3..7c1870ce 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ENiGMA½ BBS Software -![ENiGMA½ BBS](docs/images/enigma-bbs.png "ENiGMA½ BBS") +![ENiGMA½ BBS](docs/assets/images/enigma-bbs.png "ENiGMA½ BBS") ENiGMA½ is a modern BBS software with a nostalgic flair! diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index f3e6267f..66453598 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -16,13 +16,15 @@ - [Editing hjson]({{ site.baseurl }}{% link configuration/editing-hjson.md %}) - [config.hjson]({{ site.baseurl }}{% link configuration/config-hjson.md %}) - [menu.hjson]({{ site.baseurl }}{% link configuration/menu-hjson.md %}) - - prompt.hjson + - [prompt.hjson]({{ site.baseurl }}{% link configuration/prompt-hjson.md %}) - [Directory Structure]({{ site.baseurl }}{% link configuration/directory-structure.md %}) - [Archivers]({{ site.baseurl }}{% link configuration/archivers.md %}) - [File Transfer Protocols]({{ site.baseurl }}{% link configuration/file-transfer-protocols.md %}) - [Email]({{ site.baseurl }}{% link configuration/email.md %}) + - [Colour Codes]({{ site.baseurl }}{% link configuration/colour-codes.md %}) - Scheduled jobs + - File Base - [About]({{ site.baseurl }}{% link filebase/index.md %}) - [Configuring a File Area]({{ site.baseurl }}{% link filebase/first-file-area.md %}) diff --git a/docs/assets/images/colour-codes.png b/docs/assets/images/colour-codes.png new file mode 100644 index 00000000..83267a62 Binary files /dev/null and b/docs/assets/images/colour-codes.png differ diff --git a/docs/images/enigma-bbs.png b/docs/assets/images/enigma-bbs.png similarity index 100% rename from docs/images/enigma-bbs.png rename to docs/assets/images/enigma-bbs.png diff --git a/docs/images/vtxclient.png b/docs/assets/images/vtxclient.png similarity index 100% rename from docs/images/vtxclient.png rename to docs/assets/images/vtxclient.png diff --git a/docs/configuration/colour-codes.md b/docs/configuration/colour-codes.md new file mode 100644 index 00000000..9ad9abdd --- /dev/null +++ b/docs/configuration/colour-codes.md @@ -0,0 +1,25 @@ +--- +layout: page +title: Colour Codes +--- +ENiGMA½ supports Renegade-style pipe colour codes for formatting strings. You'll see them used in [`config.hjson`](config-hjson), +[`prompt.hjson`](prompt-hjson), [`menu.hjson`](menu-hjson), and can also be used in places like the oneliner, rumour mod, +full screen editor etc. + +## Usage +When ENiGMA½ encounters colour codes in strings, they'll be processed in order and combined where possible. + +For example: + +`|15|17Example` - white text on a blue background + +`|10|23Example` - light green text on a light grey background + + +## Colour Code Reference + +:warning: Colour codes |24 to |31 are considered "blinking" or "iCE" colour codes. On terminals that support them they'll +be shown as the correct colours - for terminals that don't, or are that are set to "blinking" mode - they'll blink! + +![Regegade style colour codes](../assets/images/colour-codes.png "Colour Codes") + diff --git a/docs/configuration/editing-hjson.md b/docs/configuration/editing-hjson.md index fde61290..0a752178 100644 --- a/docs/configuration/editing-hjson.md +++ b/docs/configuration/editing-hjson.md @@ -14,3 +14,7 @@ You can find more info at the [Hjson.org website](http://hjson.org/). within the IDE. It provides syntax highlighting to make it clear when you've made a syntax mistake within a config file. +### Notepad++ + +[Notepad++](https://notepad-plus-plus.org) has an Hjson plugin that provides syntax highlighting and other +usual text editor features. The plugin can be found [here](https://github.com/laktak/npp-hjson). \ No newline at end of file diff --git a/docs/configuration/prompt-hjson.md b/docs/configuration/prompt-hjson.md new file mode 100644 index 00000000..7b7a3ab5 --- /dev/null +++ b/docs/configuration/prompt-hjson.md @@ -0,0 +1,6 @@ +--- +layout: page +title: prompt.hjson +--- +:zap: This page is to describe general information the `prompt.hjson` file. It +needs fleshing out, please submit a PR if you'd like to help! \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 5cbe5670..a49f8ab1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ layout: default title: Home --- -![ENiGMA½ BBS](images/enigma-bbs.png "ENiGMA½ BBS") +![ENiGMA½ BBS](assets/images/enigma-bbs.png "ENiGMA½ BBS") ENiGMA½ is a modern BBS software with a nostalgic flair! diff --git a/docs/servers/websocket.md b/docs/servers/websocket.md index 30614006..62df02d7 100644 --- a/docs/servers/websocket.md +++ b/docs/servers/websocket.md @@ -86,6 +86,6 @@ webserver, and unpack it to a temporary directory. otherwise. 9. If you navigate to http://your-hostname.here/vtx.html, you should see a splash screen like the following: - ![VTXClient](../images/vtxclient.png "VTXClient") + ![VTXClient](../assets/images/vtxclient.png "VTXClient") \ No newline at end of file