Lots of doc updates around art
This commit is contained in:
Bryan Ashby
parent
0891fffc67
commit
b4b20e4972
|
|
@ -1,6 +1,111 @@
|
||||||
---
|
---
|
||||||
layout: page
|
layout: page
|
||||||
title: General
|
title: General Art Information
|
||||||
---
|
---
|
||||||
## General Art
|
## General Art Information
|
||||||
General art lives in the `art/general` directory. This is art (ANSI, ASCII, ...) you want to stay consistent across themes, such as a login croller or a set of logoff screens to pick randomly.
|
One of the most basic elements of BBS customization is through it's artwork. ENiGMA½ supports a variety of ways to select, display, and manage art.
|
||||||
|
|
||||||
|
As a general rule, art files live in one of two places:
|
||||||
|
|
||||||
|
1. The `art/general` directory. This is where you place command non-themed art files.
|
||||||
|
2. Within a theme such as `art/themes/super_fancy_theme`.
|
||||||
|
|
||||||
|
### Menu Entries
|
||||||
|
While art can be displayed programmatically such as from a custom module, the most basic and common form is via `menu.hjson` entries. This usually falls into one of two forms: a "standard" entry where a single `art` spec is utilized or a entry for a custom module where multiple pieces are declared and used. The second style usually takes the form of a `config.art` block with two or more entries.
|
||||||
|
|
||||||
|
A menu entry has a few elements that control how art is choosen and displayed. First, the `art` *spec* tells teh system how to look for the art asset. Second, the `config` block can further control aspecs of lookup and display:
|
||||||
|
|
||||||
|
| Item | Description|
|
||||||
|
|------|------------|
|
||||||
|
| `font` | Sets the [SyncTERM](http://syncterm.bbsdev.net/) style font to use when displaying this art. If unset, the system will use the art's embedded [SAUCE](http://www.acid.org/info/sauce/sauce.htm) record if present or simply use the current font. See Fonts below. |
|
||||||
|
| `pause` | If set to `true`, pause after displaying. |
|
||||||
|
| `baudRate` | Set a [SyncTERM](http://syncterm.bbsdev.net/) style emulated baud rate when displaying this art. In other words, slow down the display. |
|
||||||
|
| `cls` | Clear the screen before display if set to `true`. |
|
||||||
|
| `random` | Set to `false` to explicitly disable random lookup. |
|
||||||
|
| `types` | An optional array of types (aka file extensions) to consider for lookup. For example : `[ '.ans', '.asc' ]` |
|
||||||
|
| `readSauce` | May be set to `false` if you need to explictly disable SAUCE support. |
|
||||||
|
|
||||||
|
#### Art Spec
|
||||||
|
It was mentioned that the `art` member is a *spec*. The value of a `art` member controls how the system looks for an asset. The following forms are supported:
|
||||||
|
|
||||||
|
* `FOO`: The system will look for `FOO.ANS`, `FOO.ASC`, `FOO.TXT`, etc. using the default search path. Unless otherwise specified if `FOO1.ANS`, `FOO2.ANS`, and so on exist, a random selection will be made.
|
||||||
|
* `FOO.ANS`: By specifying an extension, only that type will be searched for.
|
||||||
|
* `rel/path/to/BAR.ANS`: Only match a path (relative to the system's `art` directory).
|
||||||
|
* `/path/to/BAZ.ANS`: Exact path only.
|
||||||
|
|
||||||
|
ENiGMA½ uses a fallback system for art selection. When a menu entry calls for a piece of art, the following search is made:
|
||||||
|
|
||||||
|
1. If a direct or relative path is supplied, look there first.
|
||||||
|
2. In the users current theme directory.
|
||||||
|
3. In the system default theme directory.
|
||||||
|
4. In the `art/general` directory.
|
||||||
|
|
||||||
|
#### SyncTERM Style Fonts
|
||||||
|
ENiGMA½ can set a [SyncTERM](http://syncterm.bbsdev.net/) style font for art display. This is supported by many popular BBS terminals besides just SyncTERM and is common for displaying Amiga style fonts for example. The system will use the `font` specifier or look for a font declared in an artworks SAUCE record (unless `readSauce` is `false`).
|
||||||
|
|
||||||
|
The most common fonts are probably as follows:
|
||||||
|
|
||||||
|
* `cp437`
|
||||||
|
* `c64_upper`
|
||||||
|
* `c64_lower`
|
||||||
|
* `c128_upper`
|
||||||
|
* `c128_lower`
|
||||||
|
* `atari`
|
||||||
|
* `pot_noodle`
|
||||||
|
* `mo_soul`
|
||||||
|
* `microknight_plus`
|
||||||
|
* `topaz_plus`
|
||||||
|
* `microknight`
|
||||||
|
* `topaz`
|
||||||
|
|
||||||
|
Other fonts fonts also available:
|
||||||
|
* `cp1251`
|
||||||
|
* `koi8_r`
|
||||||
|
* `iso8859_2`
|
||||||
|
* `iso8859_4`
|
||||||
|
* `cp866`
|
||||||
|
* `iso8859_9`
|
||||||
|
* `haik8`
|
||||||
|
* `iso8859_8`
|
||||||
|
* `koi8_u`
|
||||||
|
* `iso8859_15`
|
||||||
|
* `iso8859_4`
|
||||||
|
* `koi8_r_b`
|
||||||
|
* `iso8859_4`
|
||||||
|
* `iso8859_5`
|
||||||
|
* `ARMSCII_8`
|
||||||
|
* `iso8859_15`
|
||||||
|
* `cp850`
|
||||||
|
* `cp850`
|
||||||
|
* `cp885`
|
||||||
|
* `cp1251`
|
||||||
|
* `iso8859_7`
|
||||||
|
* `koi8-r_c`
|
||||||
|
* `iso8859_4`
|
||||||
|
* `iso8859_1`
|
||||||
|
* `cp866`
|
||||||
|
* `cp437`
|
||||||
|
* `cp866`
|
||||||
|
* `cp885`
|
||||||
|
* `cp866_u`
|
||||||
|
* `iso8859_1`
|
||||||
|
* `cp1131`
|
||||||
|
|
||||||
|
See [this specification](https://github.com/protomouse/synchronet/blob/master/src/conio/cterm.txt) for more information.
|
||||||
|
|
||||||
|
#### SyncTERM Style Baud Rates
|
||||||
|
The `baudRate` member can set a [SyncTERM](http://syncterm.bbsdev.net/) style emulated baud rate. May be `300`, `600`, `1200`, `2400`, `4800`, `9600`, `19200`, `38400`, `57600`, `76800`, or `115200`. A value of `ulimited`, `off`, or `0` resets (disables) the rate. See [this specification](https://github.com/protomouse/synchronet/blob/master/src/conio/cterm.txt) for more information.
|
||||||
|
|
||||||
|
## Common Example
|
||||||
|
```hjson
|
||||||
|
fullLogoffSequenceRandomBoardAd: {
|
||||||
|
art: OTHRBBS
|
||||||
|
desc: Logging Off
|
||||||
|
next: logoff
|
||||||
|
config: {
|
||||||
|
baudRate: 57600
|
||||||
|
pause: true
|
||||||
|
cls: true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
@ -9,14 +9,7 @@ ENiGMA½ comes with an advanced theming system allowing system operators to high
|
||||||
Themes live in `art/themes/`. Each theme (and thus it's *theme ID*) is a directory within the `themes` directory. The theme itself is simply a collection of art files, and a `theme.hjson` file that further defines layout, colors & formatting, etc. ENiGMA½ comes with a default theme by [Luciano Ayres](http://blocktronics.org/tag/luciano-ayres/) of [Blocktronics](http://blocktronics.org/) called Mystery Skull. This theme is in `art/themes/luciano_blocktronics`, and thus it's *theme ID* is `luciano_blocktronics`.
|
Themes live in `art/themes/`. Each theme (and thus it's *theme ID*) is a directory within the `themes` directory. The theme itself is simply a collection of art files, and a `theme.hjson` file that further defines layout, colors & formatting, etc. ENiGMA½ comes with a default theme by [Luciano Ayres](http://blocktronics.org/tag/luciano-ayres/) of [Blocktronics](http://blocktronics.org/) called Mystery Skull. This theme is in `art/themes/luciano_blocktronics`, and thus it's *theme ID* is `luciano_blocktronics`.
|
||||||
|
|
||||||
## Art
|
## Art
|
||||||
Of course one of the most basic elements of BBS theming is art. ENiGMA½ uses a fallback system for art selection by default (you may override this in a `menu.hjson` entry if desired). When a menu entry calls for a piece of art, the following search is made:
|
For information on art files, see [General Art Information](general.md). TL;DR: In general, to theme a piece of art, create a version of it in your themes directory.
|
||||||
|
|
||||||
1. If a direct or relative path is supplied, look there first.
|
|
||||||
2. In the users current theme directory.
|
|
||||||
3. In the system default theme directory.
|
|
||||||
4. In the `art/general` directory.
|
|
||||||
|
|
||||||
TL;DR: In general, to theme a piece of art, create a version of it in your themes directory.
|
|
||||||
|
|
||||||
:information_source: Remember that by default, the system will allow for randomly selecting art (in one of the directories mentioned above) by numbering it: `FOO1.ANS`, `FOO2.ANS`, etc.!
|
:information_source: Remember that by default, the system will allow for randomly selecting art (in one of the directories mentioned above) by numbering it: `FOO1.ANS`, `FOO2.ANS`, etc.!
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -33,8 +33,8 @@ Menu entries live under the `menus` section of `menu.hjson`. The *key* for a men
|
||||||
* `cls`: If `true` the screen will be cleared before showing this menu.
|
* `cls`: If `true` the screen will be cleared before showing this menu.
|
||||||
* `pause`: If `true` a pause will occur after showing this menu. Useful for simple menus such as displaying art or status screens.
|
* `pause`: If `true` a pause will occur after showing this menu. Useful for simple menus such as displaying art or status screens.
|
||||||
* `nextTimeout`: Sets the number of **milliseconds** before the system will automatically advanced to the `next` menu.
|
* `nextTimeout`: Sets the number of **milliseconds** before the system will automatically advanced to the `next` menu.
|
||||||
* `baudRate`: Sets the SyncTERM style emulated baud rate. May be `300`, `600`, `1200`, `2400`, `4800`, `9600`, `19200`, `38400`, `57600`, `76800`, or `115200`. A value of `ulimited`, `off`, or `0` resets (disables) the rate. See [this specification](https://github.com/protomouse/synchronet/blob/master/src/conio/cterm.txt) for more information.
|
* `baudRate`: See baud rate information in [General Art Information](docs/art/general.md).
|
||||||
* `font`: Sets the SyncTERM style font. May be one of the following: `cp437`, `cp1251`, `koi8_r`, `iso8859_2`, `iso8859_4`, `cp866`, `iso8859_9`, `haik8`, `iso8859_8`, `koi8_u`, `iso8859_15`, `iso8859_4`, `koi8_r_b`, `iso8859_4`, `iso8859_5`, `ARMSCII_8`, `iso8859_15`, `cp850`, `cp850`, `cp885`, `cp1251`, `iso8859_7`, `koi8-r_c`, `iso8859_4`, `iso8859_1`, `cp866`, `cp437`, `cp866`, `cp885`, `cp866_u`, `iso8859_1`, `cp1131`, `c64_upper`, `c64_lower`, `c128_upper`, `c128_lower`, `atari`, `pot_noodle`, `mo_soul`, `microknight_plus`, `topaz_plus`, `microknight`, `topaz`. See [this specification](https://github.com/protomouse/synchronet/blob/master/src/conio/cterm.txt) for more information.
|
* `font`: See font listing in [General Art Information](docs/art/general.md).
|
||||||
|
|
||||||
## Forms
|
## Forms
|
||||||
TODO
|
TODO
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue