zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-07-22 18:56:00 +02:00
Code Issues Projects Releases Packages Wiki Activity

Create colour codes docs. Create empty prompt.hjson doc page pending it being written.

Browse source
This commit is contained in:
David Stephens 2018-02-06 10:50:19 +00:00
parent 889170caf1
commit 409423c6bd
4 changed files with 34 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/configuration/colour-codes.md Normal file
View file

@ -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")