moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs

This commit is contained in:
Bryan Ashby 2018-11-17 01:21:11 -07:00
parent d83201248a
commit cf64be3550
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/art/themes.md
View File

@ -18,7 +18,7 @@ Of course one of the most basic elements of BBS theming is art. ENiGMA½ uses a
TL;DR: In general, to theme a piece of art, create a version of it in your themes directory. TL;DR: In general, to theme a piece of art, create a version of it in your themes directory.
:information: 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.!
## Theme Sections ## Theme Sections
Themes are some important sections to be aware of: Themes are some important sections to be aware of:
@ -50,7 +50,7 @@ The `customization` block in is itself broken up into major parts:
#### Defaults #### Defaults
| Item | Description | | Item | Description |
|-------------|---------------------------------------------------| |-------------|---------------------------------------------------|
| `passwordChar` | Character to display in password fields | | `passwordChar` | Character to display in password fields. Defaults to `*` |
| `dateFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for dates. | | `dateFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for dates. |
| `timeFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for times. | | `timeFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for times. |
| `dateTimeFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for date/time combinations. | | `dateTimeFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for date/time combinations. |
@ -117,16 +117,16 @@ messageAreaChangeCurrentArea: {
``` ```
## Creating Your Own ## Creating Your Own
:warning: ***IMPORTANT!*** It is recommended you don't make any customisations to the included `luciano_blocktronics' theme. Create your own and make changes to that instead: :warning: ***IMPORTANT!*** It is recommended you don't make any customisations to the included `luciano_blocktronics' theme. Instead, create your own and make changes to that instead:
1. Copy `/art/themes/luciano_blocktronics` to `art/themes/your_board_theme` 1. Copy `/art/themes/luciano_blocktronics` to `art/themes/your_board_theme`
2. Update the `info` block at the top of the theme.hjson file: 2. Update the `info` block at the top of the theme.hjson file:
``` hjson ``` hjson
info: { info: {
name: Awesome Theme name: Awesome Theme
author: Cool Artist author: Cool Artist
group: Sick Group group: Sick Group
enabled: true enabled: true // default
} }
``` ```