Cleaned up documentation, rewrote some things, added MIT license

CHANGELOG.md

@@ -0,0 +1,19 @@
+# NGenMud v1.0.0
+
+This is the base release of NGenMud which is a child/derivative of NakedMud. The goal for this is to fix some of the hanging bugs and to make step-wise feature enhancements that follow the progression that NakedMud was taking: Offloading more of the game logic to the lib and keeping the C code for the driver/engine and for modules requiring performance. Changes in this release:
+
+### FIXED:
+- The mud was not outputting an IAC,GA after prompts. I modified the socket code to spit this out after busting a prompt. Other editors may not have this, but the GA will fix some lags/delays in popular clients.
+- AutoDoc used backspace overprints, 'doc' was illegible, fixed it. Essentially this was causing headers in the doc command and readers to make titles look like 'F FI FIXED XED ED D'; this does not happen now.
+
+### MODIFIED:
+- Moved most sane options to /lib/muddata including port, paths, messaging,     and formatting options. This required changing the boot order (so that the port is read later for the sockets)
+- Changed the SCons slightly (adding libm, essentially) to make sure the mud compiled on current versions of Linux; will test this out cross-platform at a later date.
+- [Mudlib] Modified look in rooms to create both a short and long view of the exits.
+- Naming consistency (NGenMud) and branding changed throughout
+- MOTD and GREETING modified to update and bring in line with naming
+
+### ADDED:
+- "heartbeat" hook was added with a pulse of once per 2 seconds, this is intended to give scripts an easy timer.
+- .gitignore file with sane settings for NGenMud
+- Text font for who display (because it looks better while still being generic)

LICENSE.MD

@@ -0,0 +1,45 @@
+# MIT License
+
+Copyright (c) 2020 LimpingNinja
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## NOTES
+
+The original NakedMud came with the following notice, citing the source as 
+free to use without restriction and with liability limitation. I felt that 
+the formalized MIT license was the best fit for this intention. I am leaving
+the notice from Geoff Hollis and Brian Graverson, which was purely a request
+for credits that was non-binding but is "The Right Thing"(tm) to do.
+
+**Message from Geoff Hollis, Original /doc/license.txt**
+NakedMud is free to use for any purpose you would like to use it for, without 
+restriction from the creator, Geoff Hollis. By using it, or any pieces of the 
+code, you agree to absolve responsibility from the creator, Geoff Hollis, and 
+take full responsibility for anything NakedMud or pieces of the NakedMud code 
+may cause to happen.
+
+Since NakedMud was based on SocketMud by Brian Graversen, I ask that you follow
+Brian's requests as per giving credit to Erwin Andreasen for the snippets he
+supplied in SocketMud's code (see README). I also request you credit Brian for
+the work he put into SocketMud, and myself for the work I put into NakedMud.
+
+Geoff Hollis
+hollisgf@email.uc.edu
+http://www.uc.edu/~hollisgf/

doc/README → README-MORE.md

@@ -1,11 +1,11 @@
-NgenMUD
+# NgenMUD
 ---------------
 This is a mud server written in C with Python (current support 2.x with no 
 plans to upgrade yet). It is a derivative of NakedMud 3.8.1 written by Geoff 
 Hollis. Please see CREDITS and original README included at the bottom of this
 file for details.
 
-Intent
+## Intent
 ---------------
 NakedMud was left in a very workable state with some bugs and some design
 decisions that needed to be dressed up. The initial goal was to clean up the
@@ -15,22 +15,22 @@ remove as much dependency on the C code for game-related and support-related
 issues. Additionally there will be breaking changes to exposed functions and
 objects.
 
-Naming
+## Naming
 ---------------
 I'm not very creative, a long while back I had developed a pike mud driver and
 lib "GenMud + GenLib" for "Generic". When thinking of a name for a game engine,
 it made since to simply prepend N (for NakedMud). I also have always disliked 
 the name NakedMud due to the naming and penchant for disrupting search results.
 Yes, it is intended to sound like "Engine Mud".
 
-Contributing
+## Contributing
 ---------------
 I will address contributions on a case-by-case basis, please create an issue
 on the GitHub and reference your pull request: 
     https://github.com/LimpingNinja/ngenmud/issues
 
 --------------------------------------------------------------------------------
-NakedMud version 3.8.1 (Geoff Hollis)
+**NakedMud version 3.8.1 (Geoff Hollis)**
 
 NakedMud is a project I started up to keep myself entertained, and fool around
 with a couple ideas I could not work with on the MUD I run. The basic idea
@@ -53,8 +53,7 @@ hollisgf@email.uc.edu
 http://www.uc.edu/~hollisgf/
 
 --------------------------------------------------------------------------------
-
-SocketMud version 1.9 (Brian Graversen)
+**SocketMud version 1.9 (Brian Graversen) **
 
 Little mud project, which has a command interpreter and supports
 ANSI colors... has a nifty little help file system, and a few

README.md

@@ -1,15 +1,21 @@
-# NgenMUD
+# NGenMUD
 
-This is a mud server written in C with Python (current support 2.x with no plans to upgrade yet). It is a derivative of NakedMud 3.8.1 written by Geoff Hollis. Please see CREDITS and doc/README for details.
+This is a mud server written in C with Python (current support 2.x with no plans to upgrade yet). It is a derivative of NakedMud 3.8.1 written by Geoff Hollis. Please see CREDITS and doc/README for details. NakedMud was left in a very workable state with some bugs and some design decisions that needed to be dressed up and this is considered a continuation on that line. The goal is to 
+continue the work of removing existing bugs while continuing the common-sense
+segregation of some of the core 'world' functionality. I will try to keep a 
+full set of backwards compatibility where possible, while providing easy routes of migration where not.
 
-# Purpose and Intent
+Latest Release:
+    (https://github.com/LimpingNinja/ngenmud/releases/latest)
+
+# Compiling and Running
 
-NakedMud was left in a very workable state with some bugs and some design decisions that needed to be dressed up. The initial goal was to clean up the apparent bugs and Python integration. The intent, going forward, and the reason for the fork is to modify the Python integration and lib-side default state to remove as much dependency on the C code for game-related and support-related issues. Additionally there will be breaking changes to exposed functions and objects.
+The SCons system that was put in place prior to the end of NakedMud releases is still fully functional from a type-and-go point of view, v1.0.0 made a modification to ensure libm was included.
 
-# Naming?
-
-I'm not very creative, a long while back I had developed a pike mud driver and lib "GenMud + GenLib" for "Generic". When thinking of a name for a game engine, it made since to simply prepend N (for NakedMud). I also have always disliked the name NakedMud due to the naming and penchant for disrupting search results. Yes, it is intended to sound like "Engine Mud".
-
-# Contributing
-
-I will address contributions on a case-by-case basis, please create an issue and reference your pull request.
+1. Install 'SConstruct' in whatever manner your system requires it.
+2. Untar/Unzip the package into your directory and `cd ./ngenmud/src`
+3. Run: `scons`.
+4. Wait for compilation to finish, if there are errors come back here and open an issue!
+5. *Optional* `rm ../lib/muddata` - all the settings in here will be recreated off of the default settings, this can be good unless my tests slip in.  
+5. Run `./ngenmud &`: This will start the mud running on the port defined in `../lib/muddata` or, if you deleted this file, the default port of 4000.
+6. Login and have fun with your game!

doc/startup.txt → STARTING.txt

@@ -4,7 +4,7 @@ Startup should be pretty easy once you've compiled/built. With SCons, everything
 should compile automagically.
 
 Simply type ./ngenmud [port] & If you do not supply a port, the MUD will
-start up on port 5555 by default.
+start up on port 4000 by default.
 
 Building
 -----------

lib/help/C/changelog

@@ -1,16 +1,30 @@
 keywords  : changelog
 info      :~
- March-April 2020
--=-=-=-=-=-=-=-=-=-
 
+
+v1.0.0 - March 27th 2020
 FIXED:
   - The mud was not outputting an IAC,GA after prompts. I modified the socket
     code to spit this out after busting a prompt. Other editors may not have
     this, but the GA will fix some lags/delays in popular clients.
-  - AutoDoc uses backspace overprints, 'doc' was illegible, fixed it.
+  - AutoDoc used backspace overprints, 'doc' was illegible, fixed it.
 
 MODIFIED:
-
+  - Moved most sane options to /lib/muddata including port, paths, messaging,
+    and formatting options. This required changing the boot order (so that 
+    the port is read later for the sockets)
+  - Changed the SCons slightly (adding libm, essentially) to make sure the mud
+    compiled on current versions of Linux; will test this out cross-platform 
+    at a later date.
+  - [Mudlib] Modified look in rooms to create both a short and long view of
+    the exits.
+  - Naming consistency (NGenMud) and branding changed throughout
+  - MOTD and GREETING modified to update and bring in line with naming
+
 ADDED:
+  - "heartbeat" hook was added with a pulse of once per 2 seconds, this is
+    intended to give scripts an easy timer.
+  - .gitignore file with sane settings for NGenMud
+  - text for who display
 
 -

lib/misc/time

@@ -1,6 +1,6 @@
-hour        : 15
-day_of_week : 1
-day_of_month: 25
-month       : 3
-year        : 7
+hour        : 16
+day_of_week : 0
+day_of_month: 0
+month       : 0
+year        : 8
 -