enigma-bbs/README.md

# ENiGMA½ BBS Software

![alt text](docs/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
 * [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 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
 * [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/), and [Exodus](https://oddnetwork.org/exodus/) 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!
 
## In the Works
* More ES6+ usage, and **documentation**!
* More ACS support coverage
* SysOp dashboard (ye ol' WFC)
* Missing functionality such as message FTS, user coloring of messages in the FST, etc.
* String localization
* 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**
* Email: bryan -at- l33t.codes
* [Facebook ENiGMA½ group](https://www.facebook.com/groups/enigmabbs/)
* ENiGMA discussion on [fsxNet](http://bbs.geek.nz/#fsxNet)

## Terminal Clients
ENiGMA has been tested with many terminals. However, the following are suggested for BBSing:
* [SyncTERM](http://syncterm.bbsdev.net/)
* [EtherTerm](https://github.com/M-griffin/EtherTerm)
* [NetRunner](http://mysticbbs.com/downloads.html)

## Boards
* WQH: :skull: Xibalba :skull: (**telnet://xibalba.l33t.codes:44510**)
* Exotica: (**telnet://andrew.homeunix.org:2023**)
* [force9](http://bbs.force9.org/): (**telnet://bbs.force9.org**)


## Installation
```
curl -o- https://raw.githubusercontent.com/NuSkooler/enigma-bbs/master/misc/install.sh | bash
```
<br>
(See the [Quickstart](docs/index.md#quickstart) for more information)

## Special Thanks
* [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)
* Maskreet of [Throwback BBS](http://www.throwbackbbs.com/) hosting [DoorParty](http://forums.throwbackbbs.com/)!
* [Apam](https://github.com/apamment) of HappyLand BBS and [HappyNet](http://andrew.homeunix.org/doku.php?id=happynet)!

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

Copyright (c) 2015-2017, 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
Fix image, update README.md slightly 2017-07-30 17:07:02 +00:00			`![alt text](docs/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"!)`
Updated README 2015-12-11 17:55:23 +00:00			`* Highly customizable via [HJSON](http://hjson.org/) based configuration, menus, and themes in addition to JavaScript based mods`
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`
Add note about WebSocket 2017-06-23 04:24:51 +00:00			`* Telnet, SSH, and both secure and non-secure WebSocket access built in! Additional servers are easy to implement`
Merge branch 'master' of github.com:NuSkooler/enigma-bbs into 0.0.7-alpha 2017-08-06 16:33:53 +00:00			`* [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`
* Updated README.md 2015-10-27 04:19:04 +00:00			`* [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`
Fix image, update README.md slightly 2017-07-30 17:07:02 +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/), and [Exodus](https://oddnetwork.org/exodus/) 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!`
More document updates 2017-02-10 03:48:44 +00:00
* Updated README.md 2015-10-27 04:19:04 +00:00			`## In the Works`
Updates to documentation 2016-03-25 04:44:26 +00:00			`* More ES6+ usage, and documentation!`
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)`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* Missing functionality such as message FTS, user coloring of messages in the FST, etc.`
* Yet more updates to the readme 2015-10-28 17:31:20 +00:00			`* String localization`
* 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)`
Add support information 2015-11-30 21:37:38 +00:00			`* IRC: #enigma-bbs on chat.freenode.net`
			`* 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/)`
			`* ENiGMA discussion on [fsxNet](http://bbs.geek.nz/#fsxNet)`
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:`
			`* [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`
* Added Xibalba BBS README.md 2015-12-05 22:49:52 +00:00			`* WQH: :skull: Xibalba :skull: (telnet://xibalba.l33t.codes:44510)`
Add Exotica to boards 2017-03-07 03:26:25 +00:00			`* Exotica: (telnet://andrew.homeunix.org:2023)`
Documentation updates 2016-08-31 03:54:14 +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`
			```
			`<br>`
			`(See the [Quickstart](docs/index.md#quickstart) for more information)`
* Updated README.md 2015-10-27 04:19:04 +00:00
			`## Special Thanks`
* 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/)!!)`
Lots of updates for upcoming file base release 2017-01-31 04:53:37 +00:00			`* Avon of [Agency BBS](http://bbs.geek.nz/) and [fsxNet](http://bbs.geek.nz/#fsxNet)`
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/)!`
HappyNet refs 2016-07-25 07:46:17 +00:00			`* [Apam](https://github.com/apamment) of HappyLand BBS and [HappyNet](http://andrew.homeunix.org/doku.php?id=happynet)!`
* 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
Update copyrights 2017-01-26 05:59:12 +00:00			`Copyright (c) 2015-2017, 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.`