2018-01-31 23:35:54 +00:00
---
layout: page
2020-07-12 19:58:46 +00:00
title: Message Base
2018-01-31 23:35:54 +00:00
---
2020-07-12 19:58:46 +00:00
## General Information
In ENiGMA½, a message base is divided into two logical grouping components: **Message Conferences** and **Areas** . Message conferences are top level containers while areas are for a specific topic. Messages are always stored internally with a area tag.
2018-01-31 23:35:54 +00:00
2018-11-25 03:12:45 +00:00
## Conferences
Message Conferences are the top level container for *1:n* Message *Areas* via the `messageConferences` block in `config.hjson` . A common setup may include a local conference and one or more conferences each dedicated to a particular message network such as fsxNet, ArakNet, etc.
2018-01-31 23:35:54 +00:00
2018-11-25 03:12:45 +00:00
Each conference is represented by a entry under `messageConferences` . Each entries top level key is it's *conference tag* .
2018-01-31 23:35:54 +00:00
2022-07-16 18:35:39 +00:00
> :bulb: It is **highly** recommended to use snake_case style message *conference tags* and *area tags*!
2020-07-12 19:58:46 +00:00
2018-12-09 08:22:33 +00:00
| Config Item | Required | Description |
|-------------|----------|-------------|
| `name` | :+1: | Friendly conference name |
| `desc` | :+1: | Friendly conference description. |
| `sort` | :-1: | Set to a number to override the default alpha-numeric sort order based on the `name` field. |
| `default` | :-1: | Specify `true` to make this the default conference (e.g. assigned to new users) |
| `areas` | :+1: | Container of 1:n areas described below |
2020-11-22 20:53:47 +00:00
| `acs` | :-1: | A standard [ACS ](../configuration/acs.md ) block. See **ACS** below. |
2018-12-09 08:22:33 +00:00
### ACS
2020-11-22 20:53:47 +00:00
An optional standard [ACS ](../configuration/acs.md ) block can be supplied with the following rules:
2019-11-13 02:18:47 +00:00
* `read` : ACS required to read (see) this conference. Defaults to `GM[users]` .
* `write` : ACS required to write (post) to this conference. Defaults to `GM[users]` .
2018-01-31 23:35:54 +00:00
### Example
```hjson
{
messageConferences: {
2018-11-25 03:12:45 +00:00
local: { // conference tag
2018-01-31 23:35:54 +00:00
name: Local
desc: Local discussion
sort: 1
default: true
2018-12-09 08:22:33 +00:00
acs: {
read: GM[users] // default
}
2018-01-31 23:35:54 +00:00
}
}
}
```
## Message Areas
2018-11-25 03:12:45 +00:00
Message Areas are topic specific containers for messages that live within a particular conference. The top level key for an area sets it's *area tag* . For example, "General Discussion" may live under a Local conference while an fsxNet conference may contain "BBS Discussion".
2018-01-31 23:35:54 +00:00
| Config Item | Required | Description |
|-------------|----------|---------------------------------------------------------------------------------|
2018-11-25 03:12:45 +00:00
| `name` | :+1: | Friendly area name. |
| `desc` | :+1: | Friendly area description. |
| `sort` | :-1: | Set to a number to override the default alpha-numeric sort order based on the `name` field. |
| `default` | :-1: | Specify `true` to make this the default area (e.g. assigned to new users) |
2020-11-22 20:53:47 +00:00
| `acs` | :-1: | A standard [ACS ](../configuration/acs.md ) block. See **ACS** below. |
2019-08-11 04:12:55 +00:00
| `autoSignatures` | :-1: | Set to `false` to disable auto-signatures in this area. |
2020-08-31 15:28:18 +00:00
| `realNames` | :-1: | Set to `true` to use real names in this area. |
2018-12-09 08:22:33 +00:00
### ACS
2020-11-22 20:53:47 +00:00
An optional standard [ACS ](../configuration/acs.md ) block can be supplied with the following rules:
2019-11-13 02:18:47 +00:00
* `read` : ACS required to read (see) this area. Defaults to `GM[users]` .
* `write` : ACS required to write (post) to this area. Defaults to `GM[users]` .
2018-01-31 23:35:54 +00:00
### Example
```hjson
messageConferences: {
local: {
// ... see above ...
areas: {
2019-11-13 02:18:47 +00:00
enigma_dev: { // Area tag - required elsewhere!
name: ENiGMA 1/2 Development
desc: ENiGMA 1/2 development and discussion!
sort: 1
2018-12-09 08:22:33 +00:00
default: true
acs: {
read: GM[users] // default
2019-11-13 02:18:47 +00:00
write: GM[l33t] // super elite ENiGMA 1/2 users!
2018-12-09 08:22:33 +00:00
}
2018-01-31 23:35:54 +00:00
}
}
}
}
2018-11-25 03:12:45 +00:00
```
## Importing
2020-11-22 20:53:47 +00:00
FidoNet style `.na` files as well as legacy `AREAS.BBS` files in common formats can be imported using `oputil.js mb import-areas` . See [The oputil CLI ](../admin/oputil.md ) for more information and usage.