enigma-bbs/README.md

# ENiGMA½ BBS Software

![ENiGMA½ BBS](docs/assets/images/enigma-bbs.png "ENiGMA½ BBS")

ENiGMA½ is a modern BBS software with a nostalgic flair!


## Features Available Now
 * Multi platform: Anywhere [Node.js](https://nodejs.org/) runs likely works (known to work under Linux, FreeBSD, OpenBSD, OS X and Windows)
 * Unlimited multi node support (for all those BBS "callers"!)
 * **Highly** customizable via [HJSON](http://hjson.org/) based configuration, menus, and themes in addition to JavaScript based [mods](docs/mods.md)
 * [MCI support](docs/mci.md) for lightbars, toggles, input areas, and so on plus many other other bells and whistles
 * Telnet, **SSH**, and both secure and non-secure [WebSocket](https://en.wikipedia.org/wiki/WebSocket) access built in! Additional servers are easy to implement
 * [CP437](http://www.ascii-codes.com/) and UTF-8 output
 * [SyncTerm](http://syncterm.bbsdev.net/) style font and baud emulation support. Display PC/DOS and Amiga style artwork as it's intended! In general, ANSI-BBS / [cterm.txt](http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/src/conio/cterm.txt?content-type=text%2Fplain&revision=HEAD) / [bansi.txt](http://www.bbsdocumentary.com/library/PROGRAMS/GRAPHICS/ANSI/bansi.txt) are followed for expected BBS behavior
 * Full [SAUCE](http://www.acid.org/info/sauce/sauce.htm) support
 * Renegade style pipe color codes
 * [SQLite](http://sqlite.org/) storage of users, message areas, and so on
 * Strong [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) backed password encryption
 * [Door support](docs/doors.md) including common dropfile formats for legacy DOS doors. Built in [BBSLink](http://bbslink.net/), [DoorParty](http://forums.throwbackbbs.com/), [Exodus](https://oddnetwork.org/exodus/) and [CombatNet](http://combatnet.us/) support!
 * [Bunyan](https://github.com/trentm/node-bunyan) logging
 * [Message networks](docs/msg_networks.md) with FidoNet Type Network (FTN) + BinkleyTerm Style Outbound (BSO) message import/export
 * [Gazelle](https://github.com/WhatCD/Gazelle) inspirted File Bases including fast fully indexed full text search (FTS), #tags, and HTTP(S) temporary download URLs using a built in [web server](docs/web_server.md). Legacy X/Y/Z modem also supported!
 * Upload processor supporting [FILE_ID.DIZ](https://en.wikipedia.org/wiki/FILE_ID.DIZ) and [NFO](https://en.wikipedia.org/wiki/.nfo) extraction, year estimation, and more!
 * ANSI support in the Full Screen Editor (FSE), file descriptions, and so on
 
## Documentation
[Browse the docs online](https://nuskooler.github.io/enigma-bbs/)
 
## In the Works
* More ACS support coverage
* SysOp dashboard (ye ol' WFC)
* Native DOS emulation
* A lot more! Feel free to request features via [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues)

## Known Issues
As of now this is considered **alpha** code! Please **expect bugs** :bug: -- and when you find them, log issues and/or submit pull requests. Feature requests, suggestions, and so on are always welcome! I am also **looking for semi dedicated testers, artists, etc**!

See [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) for more information.

## Support
* Use [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues)
* **Discussion on a ENiGMA BBS!** (see Boards below)
* IRC: **#enigma-bbs** on **chat.freenode.net** ([webchat](https://webchat.freenode.net/?channels=enigma-bbs))
* Discussion on [fsxNet](http://bbs.geek.nz/#fsxNet) available on many boards
* Email: bryan -at- l33t.codes
* [Facebook ENiGMA½ group](https://www.facebook.com/groups/enigmabbs/)

## Terminal Clients
ENiGMA has been tested with many terminals. However, the following are suggested for BBSing:
* [VTX](https://github.com/codewar65/VTX_ClientServer) (Try [Xibalba using VTX](https://l33t.codes/vtx/xibalba.html)!)
* [SyncTERM](http://syncterm.bbsdev.net/)
* [EtherTerm](https://github.com/M-griffin/EtherTerm)
* [NetRunner](http://mysticbbs.com/downloads.html)

## Boards
* WQH: :skull: [Xibalba](https://l33t.codes/xibalba-bbs) :skull: (**telnet://xibalba.l33t.codes:44510** or via SSH secure on port 44511)
* [fORCE9](http://bbs.force9.org/): (**telnet://bbs.force9.org**)


## Installation
```
curl -o- https://raw.githubusercontent.com/NuSkooler/enigma-bbs/master/misc/install.sh | bash
```

Please see the [Quickstart](docs/index.md) for more information.

## Special Thanks
* [Dave Stephens aka RiPuk](https://github.com/davestephens) for the [KICK ASS documentation](https://nuskooler.github.io/enigma-bbs/), code contributions, etc.
* [Daniel Mecklenburg Jr.](https://github.com/codewar65) for the awesome VTX terminal and general coding talk
* [M. Brutman](http://www.brutman.com/), author of [mTCP](http://www.brutman.com/mTCP/mTCP.html) (Interwebs for DOS!)
* [M. Griffin](https://github.com/M-griffin), author of [Enthral BBS](https://github.com/M-griffin/Enthral), [Oblivion/2 XRM](https://github.com/M-griffin/Oblivion2-XRM) and [EtherTerm](https://github.com/M-griffin/EtherTerm)!
* [Caphood](http://www.reddit.com/user/Caphood), supreme SysOp of [BLACK ƒlag](http://www.bbsnexus.com/directory/listing/blackflag.html) BBS
* [Luciano Ayres](http://www.lucianoayres.com.br/) of [Blocktronics](http://blocktronics.org/), creator of the "Mystery Skulls" default ENiGMA½ theme!
* Sudndeath for Xibalba ANSI work!
* Jack Phlash for kick ass ENiGMA½ and Xibalba ASCII (Check out [IMPURE60](http://pc.textmod.es/pack/impure60/)!!)
* Avon of [Agency BBS](http://bbs.geek.nz/) and [fsxNet](http://bbs.geek.nz/#fsxNet) for putting up with my experiments to his system
* Maskreet of [Throwback BBS](http://www.throwbackbbs.com/) hosting [DoorParty](http://forums.throwbackbbs.com/)!
* [Apam](https://github.com/apamment) of [Magicka](https://magickabbs.com/)

## License
Released under the [BSD 2-clause](https://opensource.org/licenses/BSD-2-Clause) license:

Copyright (c) 2015-2018, Bryan D. Ashby
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* Updated README.md 2015-10-27 04:19:04 +00:00			`# ENiGMA½ BBS Software`
* Lots of WIP on FSE demo * WIP emit position from MutliLineEditTextView * ansi.rawWrite() when no iconv/lfs to be processed 2015-07-06 01:05:55 +00:00
OCD docs tidy-up 2018-02-06 10:20:17 +00:00			`![ENiGMA½ BBS](docs/assets/images/enigma-bbs.png "ENiGMA½ BBS")`
More readme updates - added image by Luciano 2015-10-28 21:14:12 +00:00
* Updated README.md 2015-10-27 04:19:04 +00:00			`ENiGMA½ is a modern BBS software with a nostalgic flair!`


Add special thanks, minor updates to logs, etc. 2016-07-03 01:26:57 +00:00			`## Features Available Now`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* Multi platform: Anywhere [Node.js](https://nodejs.org/) runs likely works (known to work under Linux, FreeBSD, OpenBSD, OS X and Windows)`
			`* Unlimited multi node support (for all those BBS "callers"!)`
Switch to sqltie-trans, a more updated transaction handling module 2017-09-19 03:05:38 +00:00			`* Highly customizable via [HJSON](http://hjson.org/) based configuration, menus, and themes in addition to JavaScript based [mods](docs/mods.md)`
Fix image, update README.md slightly 2017-07-30 17:07:02 +00:00			`* [MCI support](docs/mci.md) for lightbars, toggles, input areas, and so on plus many other other bells and whistles`
Updates + thanks 2017-08-27 23:08:48 +00:00			`* Telnet, SSH, and both secure and non-secure [WebSocket](https://en.wikipedia.org/wiki/WebSocket) access built in! Additional servers are easy to implement`
			`* [CP437](http://www.ascii-codes.com/) and UTF-8 output`
Updated README 2015-12-11 17:55:23 +00:00			`* [SyncTerm](http://syncterm.bbsdev.net/) style font and baud emulation support. Display PC/DOS and Amiga style artwork as it's intended! In general, ANSI-BBS / [cterm.txt](http://cvs.synchro.net/cgi-bin/viewcvs.cgi/checkout/src/conio/cterm.txt?content-type=text%2Fplain&revision=HEAD) / [bansi.txt](http://www.bbsdocumentary.com/library/PROGRAMS/GRAPHICS/ANSI/bansi.txt) are followed for expected BBS behavior`
Start to wrap up 0.0.7-alpha 2017-09-08 00:15:10 +00:00			`* Full [SAUCE](http://www.acid.org/info/sauce/sauce.htm) support`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* Renegade style pipe color codes`
			`* [SQLite](http://sqlite.org/) storage of users, message areas, and so on`
Updated README 2015-12-11 17:55:23 +00:00			`* Strong [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) backed password encryption`
CombatNet support! 2017-11-02 00:41:20 +00:00			`* [Door support](docs/doors.md) including common dropfile formats for legacy DOS doors. Built in [BBSLink](http://bbslink.net/), [DoorParty](http://forums.throwbackbbs.com/), [Exodus](https://oddnetwork.org/exodus/) and [CombatNet](http://combatnet.us/) support!`
* Updated readme a bit 2015-10-27 22:20:44 +00:00			`* [Bunyan](https://github.com/trentm/node-bunyan) logging`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* [Message networks](docs/msg_networks.md) with FidoNet Type Network (FTN) + BinkleyTerm Style Outbound (BSO) message import/export`
More document updates 2017-02-10 03:48:44 +00:00			`* [Gazelle](https://github.com/WhatCD/Gazelle) inspirted File Bases including fast fully indexed full text search (FTS), #tags, and HTTP(S) temporary download URLs using a built in [web server](docs/web_server.md). Legacy X/Y/Z modem also supported!`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* Upload processor supporting [FILE_ID.DIZ](https://en.wikipedia.org/wiki/FILE_ID.DIZ) and [NFO](https://en.wikipedia.org/wiki/.nfo) extraction, year estimation, and more!`
Updates + thanks 2017-08-27 23:08:48 +00:00			`* ANSI support in the Full Screen Editor (FSE), file descriptions, and so on`
More document updates 2017-02-10 03:48:44 +00:00
Add docs link on README/etc. 2018-02-03 05:01:54 +00:00			`## Documentation`
			`[Browse the docs online](https://nuskooler.github.io/enigma-bbs/)`

* Updated README.md 2015-10-27 04:19:04 +00:00			`## In the Works`
Various minor doc updates 2016-03-29 04:58:06 +00:00			`* More ACS support coverage`
Updated README 2015-12-11 17:55:23 +00:00			`* SysOp dashboard (ye ol' WFC)`
Add docs link on README/etc. 2018-02-03 05:01:54 +00:00			`* Native DOS emulation`
* Link to issue tracker 2015-10-28 22:31:17 +00:00			`* A lot more! Feel free to request features via [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues)`
* Updated README.md 2015-10-27 04:19:04 +00:00
* Updated readme a bit 2015-10-27 22:20:44 +00:00			`## Known Issues`
Update slightly 2015-11-30 21:44:07 +00:00			`As of now this is considered alpha code! Please expect bugs :bug: -- and when you find them, log issues and/or submit pull requests. Feature requests, suggestions, and so on are always welcome! I am also looking for semi dedicated testers, artists, etc!`

			`See [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) for more information.`
* Updated README.md 2015-10-27 04:19:04 +00:00
Add support information 2015-11-30 21:37:38 +00:00			`## Support`
			`* Use [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues)`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* Discussion on a ENiGMA BBS! (see Boards below)`
Just add a link to the webchat For people who don't have a IRC client installed. 2017-10-27 15:59:45 +00:00			`* IRC: #enigma-bbs on chat.freenode.net ([webchat](https://webchat.freenode.net/?channels=enigma-bbs))`
Start to wrap up 0.0.7-alpha 2017-09-08 00:15:10 +00:00			`* Discussion on [fsxNet](http://bbs.geek.nz/#fsxNet) available on many boards`
Add support information 2015-11-30 21:37:38 +00:00			`* Email: bryan -at- l33t.codes`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* [Facebook ENiGMA½ group](https://www.facebook.com/groups/enigmabbs/)`
Add support information 2015-11-30 21:37:38 +00:00
* Yet more updates to the readme 2015-10-28 17:31:20 +00:00			`## Terminal Clients`
			`ENiGMA has been tested with many terminals. However, the following are suggested for BBSing:`
Updates + thanks 2017-08-27 23:08:48 +00:00			`* [VTX](https://github.com/codewar65/VTX_ClientServer) (Try [Xibalba using VTX](https://l33t.codes/vtx/xibalba.html)!)`
* Yet more updates to the readme 2015-10-28 17:31:20 +00:00			`* [SyncTERM](http://syncterm.bbsdev.net/)`
			`* [EtherTerm](https://github.com/M-griffin/EtherTerm)`
			`* [NetRunner](http://mysticbbs.com/downloads.html)`

* Updated README.md 2015-10-27 04:19:04 +00:00			`## Boards`
xibalba link 2017-09-08 02:36:51 +00:00			`* WQH: :skull: [Xibalba](https://l33t.codes/xibalba-bbs) :skull: (telnet://xibalba.l33t.codes:44510 or via SSH secure on port 44511)`
Minor updates 2018-02-03 04:58:17 +00:00			`* [fORCE9](http://bbs.force9.org/): (telnet://bbs.force9.org)`
* Updated README.md 2015-10-27 04:19:04 +00:00

			`## Installation`
Documentation updates 2016-08-31 03:54:14 +00:00			```
			`curl -o- https://raw.githubusercontent.com/NuSkooler/enigma-bbs/master/misc/install.sh \| bash`
			```
Try again to fix quickstart link - GitHub being dumb 2017-09-08 02:35:42 +00:00
Fix quickstart link 2017-09-08 02:34:01 +00:00			`Please see the [Quickstart](docs/index.md) for more information.`
* Updated README.md 2015-10-27 04:19:04 +00:00
			`## Special Thanks`
Minor updates 2018-02-03 04:58:17 +00:00			`* [Dave Stephens aka RiPuk](https://github.com/davestephens) for the [KICK ASS documentation](https://nuskooler.github.io/enigma-bbs/), code contributions, etc.`
Updates + thanks 2017-08-27 23:08:48 +00:00			`* [Daniel Mecklenburg Jr.](https://github.com/codewar65) for the awesome VTX terminal and general coding talk`
* Updated readme a bit 2015-10-27 22:20:44 +00:00			`* [M. Brutman](http://www.brutman.com/), author of [mTCP](http://www.brutman.com/mTCP/mTCP.html) (Interwebs for DOS!)`
* Yet more updates to the readme 2015-10-28 17:31:20 +00:00			`* [M. Griffin](https://github.com/M-griffin), author of [Enthral BBS](https://github.com/M-griffin/Enthral), [Oblivion/2 XRM](https://github.com/M-griffin/Oblivion2-XRM) and [EtherTerm](https://github.com/M-griffin/EtherTerm)!`
* Updated readme a bit 2015-10-27 22:20:44 +00:00			`* [Caphood](http://www.reddit.com/user/Caphood), supreme SysOp of [BLACK ƒlag](http://www.bbsnexus.com/directory/listing/blackflag.html) BBS`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* [Luciano Ayres](http://www.lucianoayres.com.br/) of [Blocktronics](http://blocktronics.org/), creator of the "Mystery Skulls" default ENiGMA½ theme!`
Various minor doc updates 2016-03-29 04:58:06 +00:00			`* Sudndeath for Xibalba ANSI work!`
			`* Jack Phlash for kick ass ENiGMA½ and Xibalba ASCII (Check out [IMPURE60](http://pc.textmod.es/pack/impure60/)!!)`
Minor updates 2018-02-03 04:58:17 +00:00			`* Avon of [Agency BBS](http://bbs.geek.nz/) and [fsxNet](http://bbs.geek.nz/#fsxNet) for putting up with my experiments to his system`
Add special thanks to Maskreet for DoorParty 2016-06-02 02:15:55 +00:00			`* Maskreet of [Throwback BBS](http://www.throwbackbbs.com/) hosting [DoorParty](http://forums.throwbackbbs.com/)!`
Minor updates 2018-02-03 04:58:17 +00:00			`* [Apam](https://github.com/apamment) of [Magicka](https://magickabbs.com/)`
* Updated README.md 2015-10-27 04:19:04 +00:00
			`## License`
			`Released under the [BSD 2-clause](https://opensource.org/licenses/BSD-2-Clause) license:`
* Lots of WIP on FSE demo * WIP emit position from MutliLineEditTextView * ansi.rawWrite() when no iconv/lfs to be processed 2015-07-06 01:05:55 +00:00
Minor updates 2018-02-03 04:58:17 +00:00			`Copyright (c) 2015-2018, Bryan D. Ashby`
* Updated readme a bit 2015-10-27 22:20:44 +00:00			`All rights reserved.`

			`Redistribution and use in source and binary forms, with or without`
			`modification, are permitted provided that the following conditions are met:`

			`* Redistributions of source code must retain the above copyright notice, this`
			`list of conditions and the following disclaimer.`

			`* Redistributions in binary form must reproduce the above copyright notice,`
			`this list of conditions and the following disclaimer in the documentation`
			`and/or other materials provided with the distribution.`

			`THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"`
			`AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE`
			`DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE`
			`FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR`
			`SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER`
			`CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,`
			`OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE`
			`OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`