enigma-bbs/README.md

8.0 KiB

ENiGMA½ BBS Software

ENiGMA½ BBS

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)
  • Unlimited multi node support (for all those BBS "callers"!)
  • 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, and both secure and non-secure WebSocket access built in! Additional servers are easy to implement
  • 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.
  • Full SAUCE support.
  • Renegade style pipe color codes.
  • SQLite storage of users, message areas, etc.
  • Strong PBKDF2 backed password encryption.
  • Support for 2-Factor Authentication with One-Time-Passwords
  • Door support including common dropfile formats for legacy DOS doors. Built in BBSLink, DoorParty, Exodus and CombatNet support!
  • Bunyan logging!
  • Message networks with FidoNet Type Network (FTN) + BinkleyTerm Style Outbound (BSO) message import/export. Messages Bases can also be exposed via Gopher, or NNTP!
  • Gazelle inspired File Bases including fast fully indexed full text search (FTS), #tags, and HTTP(S) temporary download URLs using a built in web server. Legacy X/Y/Z modem also supported!
  • Upload processor supporting FILE_ID.DIZ and NFO extraction, year estimation, and more!
  • ANSI support in the Full Screen Editor (FSE), file descriptions, etc.
  • A built in achievement system. BBSing gamified!

Documentation

Browse the docs online. Be sure to checkout the /docs/ folder as well for the latest and greatest documentation.

In the Works

Many more features are in the pipeline. Checkout the the issue tracker and feel free to request features (or contribute!) features.

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. With that said, the code is actually quite stable and is used by a number of boards.

See the issue tracker for more information.

Support

Terminal Clients

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

Boards

  • WQH: 💀 Xibalba 💀 (ssh://xibalba.l33t.codes:44511 or telnet://xibalba.l33t.codes:44510)
  • fORCE9: (telnet://bbs.force9.org)
  • Undercurrents: (ssh://undercurrents.io)
  • PlaneT Afr0: (ssh://planetafr0.org:8889)

Installation

On *nix type systems:

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

Please see Installation Methods for Windows, Docker, and so on...

Special Thanks

License

Released under the BSD 2-clause license:

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