Go to file
Bryan Ashby 99ab60bf77 * Convert MenuModule to ES6 style class
* Convert modules that are MenuModule subclasses to ES6 style classes
* Convert mixins to ES6 style
* Various cleanup
2017-01-25 22:18:05 -07:00
.github Add ISSUE_TEMPLATE.md 2016-02-17 20:44:46 -07:00
core * Convert MenuModule to ES6 style class 2017-01-25 22:18:05 -07:00
docs Initial MCI docs 2017-01-23 20:21:07 -07:00
misc * Some WIP on file area releated stuff - various partially implemented pieces coming together 2016-09-28 21:54:25 -06:00
mods * Convert MenuModule to ES6 style class 2017-01-25 22:18:05 -07:00
.eslintrc.json Fix switch rule 2016-08-03 22:36:35 -06:00
.gitattributes Add uppercase extentions, e.g. .ANS 2015-12-12 16:28:40 -07:00
.gitignore * Add .gitignore 2015-10-27 20:46:30 -06:00
LICENSE.TXT Update license date 2016-08-20 15:26:18 -06:00
README.md Documentation updates 2016-08-30 21:54:14 -06:00
main.js * Fix updating of existing file filter 2017-01-18 22:23:53 -07:00
mkdocs.yml * Some doc changes 2015-11-20 11:56:57 -07:00
oputil.js * Improvements to ANSI parser 2016-12-06 18:58:56 -07:00
package.json * Convert MenuModule to ES6 style class 2017-01-25 22:18:05 -07:00

README.md

ENiGMA½ BBS Software

alt text

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

Features Available Now

  • Multi platform: Anywhere Node.js runs likely works (known to work under Linux, FreeBSD, OpenBSD, OS X and Windows)
  • Multi node support
  • Highly customizable via HJSON based configuration, menus, and themes in addition to JavaScript based mods
  • MCI support for lightbars, toggles, input areas, and so on plus many other other bells and whistles
  • Telnet & SSH access built in. Additional servers are easy to implement & plug in
  • CP437 and UTF-8 output
  • SyncTerm style font and baud emulation support. Display PC/DOS and Amiga style artwork as it's intended! In general, ANSI-BBS / cterm.txt / bansi.txt are followed for expected BBS behavior
  • SAUCE support
  • Pipe codes (ala Renegade)
  • SQLite storage of users and message areas
  • Strong PBKDF2 backed password encryption
  • Door support including common dropfile formats and legacy DOS doors, BBSLink, and DoorParty! (See Doors)
  • Bunyan logging
  • FidoNet Type Network (FTN) + BinkleyTerm Style Outbound (BSO) message import/export

In the Works

  • More ES6+ usage, and documentation!
  • File areas
  • More ACS support coverage
  • SysOp dashboard (ye ol' WFC)
  • Missing functionality such as searching, message area coloring, etc.
  • String localization
  • A lot more! Feel free to request features via the issue tracker

Known Issues

As of now this is considered alpha code! Please expect bugs 🐛 -- 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 for more information.

Support

  • Use the issue tracker
  • Discussion on a ENiGMA BBS!
  • IRC: #enigma-bbs on chat.freenode.net
  • Email: bryan -at- l33t.codes
  • Facebook ENiGMA½ group
  • ENiGMA discussion on HappyNet

Terminal Clients

ENiGMA has been tested with many terminals. However, the following are suggested for BBSing:

Boards

  • WQH: 💀 Xibalba 💀 (telnet://xibalba.l33t.codes:44510)
  • Support board: ☠ BLACK ƒlag ☠ (telnet://blackflag.acid.org:2425)
  • force9: (telnet://bbs.force9.org)

Installation

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

(See the [Quickstart](docs/index.md#quickstart) for more information)

Special Thanks

License

Released under the BSD 2-clause license:

Copyright (c) 2015-2016, 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.