This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
magicka/README.md

58 lines
1.9 KiB
Markdown
Raw Normal View History

2016-03-22 11:58:52 +10:00
# MagickaBBS
2016-04-09 16:17:07 +10:00
Linux/FreeBSD bulletin board system (Should also work on NetBSD and OpenBSD, if it doesn't it's a bug)
2016-03-22 11:58:52 +10:00
2016-04-09 16:17:07 +10:00
As I lost the code to my initial BBS flea, I've decided to start over from scratch and this time I'm using git hub so I dont
2016-03-22 11:58:52 +10:00
lose it again!
2016-04-03 15:26:25 +10:00
Magicka is meant to be a modern (haha) BBS system, using modern technologies, like Sqlite, IRC, long filenames (gasp!) etc
2016-03-22 11:58:52 +10:00
while still retaining the classic BBS feel. ANSI & Telnet, and good old ZModem.
If you want to install Magicka BBS, follow these steps.
1. Ensure you have git, c compiler, sqlite-dev and gnu make
2016-03-23 18:43:44 +10:00
2. Clone the repo `git clone https://github.com/apamment/MagickaBBS`
2016-04-10 09:50:58 +10:00
***This is the master branch, it's recommended to check out the 0.1 branch***
2016-04-10 09:04:25 +10:00
cd MagickaBBS/
git checkout 0.1
3. Build JamLib
2016-03-25 10:58:57 +10:00
`cd MagickaBBS/jamlib`
2016-03-23 18:41:45 +10:00
2016-03-25 10:58:57 +10:00
2016-04-09 16:17:07 +10:00
`make -f Makefile.linux` (Linux) `gmake -f Makefile.linux` (*BSD)
2016-03-25 10:58:57 +10:00
2016-04-03 11:07:20 +10:00
3. Build libzmodem
`cd MagickaBBS/Xmodem`
2016-04-09 16:17:07 +10:00
`make` (Linux) `gmake` (*BSD)
2016-04-03 11:07:20 +10:00
5. Build the BBS (You may have to adjust the Makefile for your system)
2016-04-09 16:17:07 +10:00
`make` (Linux) `gmake` (*BSD)
2016-04-03 11:07:20 +10:00
6. Copy the config-default directory to a config directory.
`cp -r config_default config`
2016-04-03 11:07:20 +10:00
7. Edit the config files and update essential information, like system paths and BBS name etc
8. Copy the ansi-default directory to the one specified in your system path
2016-03-23 18:41:45 +10:00
eg.
`cp -r ansi_default ansis`
2016-04-03 11:07:20 +10:00
9. Run Magicka BBS on a port over 1024 (Below require root, and we're not ready for that).
2016-03-23 18:40:40 +10:00
`./magicka config/bbs.ini 2300`
2016-04-03 11:07:20 +10:00
10. Your BBS is now running on port 2300, log in and create yourself an account! (By default there is only one security level, you can add more,
2016-03-23 18:52:31 +10:00
but you will need to use an SQLite Manager to modify users.sq3 and set security levels, as there is no user editor yet.
2016-04-09 16:17:07 +10:00
For information on how to configure your BBS, check the wiki https://github.com/apamment/MagickaBBS/wiki