09f6ad1d0c
* Start work on config.md configuration notes |
||
---|---|---|
core | ||
docs | ||
misc | ||
mods | ||
.gitignore | ||
LICENSE.TXT | ||
README.md | ||
main.js | ||
mkdocs.yml | ||
package.json |
README.md
ENiGMA½ BBS Software
ENiGMA½ is a modern BBS software with a nostalgic flair!
Feature Available Now
- Multi platform: Anywhere Node.js runs likely works (tested under Linux and OS X)
- Multi node support
- Highly customizable via HJSON based configuration, menus, and themes in addition to JS 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
- 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.
- 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.
Terminal Clients
ENiGMA has been tested with many terminals. However, the following are suggested for BBSing:
Boards
- WQH: 💀 Xibalba 💀
- Support board: BLACK ƒlag (telnet://blackflag.acid.org:2425)
Installation
Clone
git clone https://github.com/NuSkooler/enigma-bbs.git
Create a Config
/* ~/.config/enigma-bbs/config.hjson */
general: {
boardName: Super Awesome BBS
}
messages: {
areas: [
{ name: "local_enigma_discusssion", desc: "ENiGMA Discussion", groups: [ "users" ] }
]
}
Install dependencies
npm install
Generate a PK for SSH usage
mkdir misc
openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048
After generation, set servers.ssh.privateKeyPass to your password in config.hjson:
servers: {
ssh: {
privateKeyPass: YOUR_PK_PASS
}
}
Launch
node main.js
(More information will be available in the documentation in the near future)
Special Thanks
- M. Brutman, author of mTCP (Interwebs for DOS!)
- M. Griffin, author of Enthral BBS, Oblivion/2 XRM and EtherTerm!
- Caphood, supreme SysOp of BLACK ƒlag BBS
- Luciano Ayres of Blocktronics, creator of the "Mystery Skulls" default ENiGMA½ theme!
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.