moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
enigma-bbs/README.md

4.0 KiB
Raw Blame History

ENiGMA½ BBS Software

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

Feature Available Now

  • Multiplatform: Anywhere Node.js runs likely works (tested under Linux and OS X)
  • Multi node support
  • Highly customizable via HJSON based configuration, menus, and theming in addition to JS based mods
  • MCI support for lightbars, toggles, input areas, other bells and whistles you expect with a modern flare
  • Telnet & SSH access built in. Additional servers are easy to build & 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!
  • SAUCE support
  • Renegade style pipe codes
  • SQLite storage of users and message areas
  • Strong PBKDF2 backed password storage
  • Door support including common dropfile formats and DOSEMU
  • Bunyan logging

In the Works

  • Lots of code cleanup, ES6+ usage, and documentation!
  • FTN import & export
  • File areas
  • Full access checking framework
  • SysOp console
  • Missing functionality such as searching, pipe code support in message areas, etc.
  • A lot more!

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.

Boards

  • WQH: Xibalba
  • Support board: BLACK ƒlag (telnet://blackflag.acid.org:2425)

Installation

  1. Clone:
git clone https://github.com/NuSkooler/enigma-bbs.git
  1. Create ~/.enigma-bbs/config.hjson. Example:
general: {
  boardName: Super Awesome BBS
}
messages: {
  areas: [
    { name: "local_enigma_discusssion", desc: "ENiGMA Discussion", groups: [ "users" ] }
  ]
}
  1. Install dependencies:
npm install
  1. Launch:
node main.js

(More information will be available in the documentation in the near future)

Special Thanks

License

Released under the BSD 2-clause license:

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