Checkin for 2017.01

.gitignore

@@ -0,0 +1,7 @@
+logs
+db
+datadir
+npm-debug.log
+nohup.out
+uploads
+

LICENSE

@@ -0,0 +1,201 @@
+		       The Artistic License 2.0
+
+	    Copyright (c) 2000-2006, The Perl Foundation.
+
+     Everyone is permitted to copy and distribute verbatim copies
+      of this license document, but changing it is not allowed.
+
+Preamble
+
+This license establishes the terms under which a given free software
+Package may be copied, modified, distributed, and/or redistributed.
+The intent is that the Copyright Holder maintains some artistic
+control over the development of that Package while still keeping the
+Package available as open source and free software.
+
+You are always permitted to make arrangements wholly outside of this
+license directly with the Copyright Holder of a given Package.  If the
+terms of this license do not permit the full use that you propose to
+make of the Package, you should contact the Copyright Holder and seek
+a different licensing arrangement. 
+
+Definitions
+
+    "Copyright Holder" means the individual(s) or organization(s)
+    named in the copyright notice for the entire Package.
+
+    "Contributor" means any party that has contributed code or other
+    material to the Package, in accordance with the Copyright Holder's
+    procedures.
+
+    "You" and "your" means any person who would like to copy,
+    distribute, or modify the Package.
+
+    "Package" means the collection of files distributed by the
+    Copyright Holder, and derivatives of that collection and/or of
+    those files. A given Package may consist of either the Standard
+    Version, or a Modified Version.
+
+    "Distribute" means providing a copy of the Package or making it
+    accessible to anyone else, or in the case of a company or
+    organization, to others outside of your company or organization.
+
+    "Distributor Fee" means any fee that you charge for Distributing
+    this Package or providing support for this Package to another
+    party.  It does not mean licensing fees.
+
+    "Standard Version" refers to the Package if it has not been
+    modified, or has been modified only in ways explicitly requested
+    by the Copyright Holder.
+
+    "Modified Version" means the Package, if it has been changed, and
+    such changes were not explicitly requested by the Copyright
+    Holder. 
+
+    "Original License" means this Artistic License as Distributed with
+    the Standard Version of the Package, in its current version or as
+    it may be modified by The Perl Foundation in the future.
+
+    "Source" form means the source code, documentation source, and
+    configuration files for the Package.
+
+    "Compiled" form means the compiled bytecode, object code, binary,
+    or any other form resulting from mechanical transformation or
+    translation of the Source form.
+
+
+Permission for Use and Modification Without Distribution
+
+(1)  You are permitted to use the Standard Version and create and use
+Modified Versions for any purpose without restriction, provided that
+you do not Distribute the Modified Version.
+
+
+Permissions for Redistribution of the Standard Version
+
+(2)  You may Distribute verbatim copies of the Source form of the
+Standard Version of this Package in any medium without restriction,
+either gratis or for a Distributor Fee, provided that you duplicate
+all of the original copyright notices and associated disclaimers.  At
+your discretion, such verbatim copies may or may not include a
+Compiled form of the Package.
+
+(3)  You may apply any bug fixes, portability changes, and other
+modifications made available from the Copyright Holder.  The resulting
+Package will still be considered the Standard Version, and as such
+will be subject to the Original License.
+
+
+Distribution of Modified Versions of the Package as Source 
+
+(4)  You may Distribute your Modified Version as Source (either gratis
+or for a Distributor Fee, and with or without a Compiled form of the
+Modified Version) provided that you clearly document how it differs
+from the Standard Version, including, but not limited to, documenting
+any non-standard features, executables, or modules, and provided that
+you do at least ONE of the following:
+
+    (a)  make the Modified Version available to the Copyright Holder
+    of the Standard Version, under the Original License, so that the
+    Copyright Holder may include your modifications in the Standard
+    Version.
+
+    (b)  ensure that installation of your Modified Version does not
+    prevent the user installing or running the Standard Version. In
+    addition, the Modified Version must bear a name that is different
+    from the name of the Standard Version.
+
+    (c)  allow anyone who receives a copy of the Modified Version to
+    make the Source form of the Modified Version available to others
+    under
+
+	(i)  the Original License or
+
+	(ii)  a license that permits the licensee to freely copy,
+	modify and redistribute the Modified Version using the same
+	licensing terms that apply to the copy that the licensee
+	received, and requires that the Source form of the Modified
+	Version, and of any works derived from it, be made freely
+	available in that license fees are prohibited but Distributor
+	Fees are allowed.
+
+
+Distribution of Compiled Forms of the Standard Version 
+or Modified Versions without the Source
+
+(5)  You may Distribute Compiled forms of the Standard Version without
+the Source, provided that you include complete instructions on how to
+get the Source of the Standard Version.  Such instructions must be
+valid at the time of your distribution.  If these instructions, at any
+time while you are carrying out such distribution, become invalid, you
+must provide new instructions on demand or cease further distribution.
+If you provide valid instructions or cease distribution within thirty
+days after you become aware that the instructions are invalid, then
+you do not forfeit any of your rights under this license.
+
+(6)  You may Distribute a Modified Version in Compiled form without
+the Source, provided that you comply with Section 4 with respect to
+the Source of the Modified Version.
+
+
+Aggregating or Linking the Package 
+
+(7)  You may aggregate the Package (either the Standard Version or
+Modified Version) with other packages and Distribute the resulting
+aggregation provided that you do not charge a licensing fee for the
+Package.  Distributor Fees are permitted, and licensing fees for other
+components in the aggregation are permitted. The terms of this license
+apply to the use and Distribution of the Standard or Modified Versions
+as included in the aggregation.
+
+(8) You are permitted to link Modified and Standard Versions with
+other works, to embed the Package in a larger work of your own, or to
+build stand-alone binary or bytecode versions of applications that
+include the Package, and Distribute the result without restriction,
+provided the result does not expose a direct interface to the Package.
+
+
+Items That are Not Considered Part of a Modified Version 
+
+(9) Works (including, but not limited to, modules and scripts) that
+merely extend or make use of the Package, do not, by themselves, cause
+the Package to be a Modified Version.  In addition, such works are not
+considered parts of the Package itself, and are not subject to the
+terms of this license.
+
+
+General Provisions
+
+(10)  Any use, modification, and distribution of the Standard or
+Modified Versions is governed by this Artistic License. By using,
+modifying or distributing the Package, you accept this license. Do not
+use, modify, or distribute the Package, if you do not accept this
+license.
+
+(11)  If your Modified Version has been derived from a Modified
+Version made by someone other than you, you are nevertheless required
+to ensure that your Modified Version complies with the requirements of
+this license.
+
+(12)  This license does not grant you the right to use any trademark,
+service mark, tradename, or logo of the Copyright Holder.
+
+(13)  This license includes the non-exclusive, worldwide,
+free-of-charge patent license to make, have made, use, offer to sell,
+sell, import and otherwise transfer the Package with respect to any
+patent claims licensable by the Copyright Holder that are necessarily
+infringed by the Package. If you institute patent litigation
+(including a cross-claim or counterclaim) against any party alleging
+that the Package constitutes direct or contributory patent
+infringement, then this Artistic License to you shall terminate on the
+date that such litigation is filed.
+
+(14)  Disclaimer of Warranty:
+THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
+IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
+NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL
+LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,139 @@
+# Shroud of the Avatar Companion
+
+This package contains a daemon (server or service for those
+brought up on Windows) that is run on the same computer as
+the Shroud of the Avatar Game Client. This daemon will watch
+the files generated in the directory know as the "datafolder"
+and will parse that information and present it as web pages.
+
+In addition it will add the players location to some chatlog
+entries and store them in it's own data area.
+
+The daemon us built using node.js and therefor should run
+on any platform that can run Shroud. The author only uses
+linux and OSX so testing on Windows will have to be done by
+other.
+
+This package is Open Source under the Artistic License 2.0 and
+you can use it without charge.
+
+## How to download and install
+
+You will need a 5.6 or better version of node.js and npm
+
+### Basic Step to install
+
+1. Install the newest version of node.js and npm
+2. Download The most current release of sota-companion (Currently 2017.01)
+3. Unpack the release.
+4. cd to ..../daemon
+5. Run the "npm install" command to get all the necessary Node Packages.
+6. Run npm start (with debug turned on if you want).
+7. Point you browser to localhost:14444 and configure your Data Directory.
+8. In game write the stats to the chatlog using /stats.
+9. Go to the SotA-Companion home page and see that the data is valid.
+
+### Install the 6.x version of node.js and npm
+
+You will need node.js and npm, there are packages for this
+software for Windows, Mac OSX, Fedora, and Ubuntu, just search
+the web.
+
+NOTE you will need  at lease version 4.6.1 and better to get the
+newest one (6.x) While this is default on OSX, and Fedora, and Windows.
+for Ubuntu you can NOT use the package shipped with the current LTS versions
+of Ubuntu (which is a 0.10 version)
+
+### Download The most current release of sota-companion 
+
+Go to [The SotA-Companion github repository](https://github.com/pwd3/sota-companion)
+and select the "releases" item at the top of the page.
+Download the release you are looking for in either zip or tar.gz format (they have
+the same data in them).
+
+### Unpack the release.
+
+Unpack the zip or tar.gz file in a location that you want to run sota-companion from.
+This should be in an area that your userid can write to. For OSX and linux somewhere
+in your home directory is good.
+
+### cd to ..../daemon
+
+Open a command line tool (shell for OSX or linux, cmd or powershell for Windows) and
+cd to the daemon directory that will be present in the unpacked area.
+
+### Run the "npm install" command 
+
+SotA-Companion uses a number of node packages. The release does not contain these
+packages as some of them have binaries for the OS and the structure of the node-modules
+directory differs with different versions of node. in the daemon directory run
+the command "npm install" which will download all the needed packages and install them.
+You do NOT need to be an Administrator or Super User to do any of these steps.
+
+### Run npm start 
+
+Now you need to start the two processes that run all the time collecting data. One
+the "Watchdog" make sure the other "WWW" is running and restarts it if any code or
+configuration changes (you can find both in the "bin" directory.
+
+You can enable debuging output with the ENV variable  DEBUG=daemon:\* befor the npm start.
+
+Type in npm start or:
+
+* DEBUG=daemon:\* npm start on Linux
+
+* SET DEBUG=daemon:\* npm start on OSX
+
+* set DEBUG=daemon:\* npm start on Windows (CMD)
+
+* $env\:DEBUG="daemon:\*" npm start on Windows (Powershell)
+
+
+### Point you browser to localhost:14444 
+
+The user interface to SotA-Companion is your browser pointed to
+[localhost:14444](localhost:14444)
+
+When you first point to this page (while the daemon is running) 
+you will be re-directed to the profile page because your data directory
+is not set. Start the game and, in the chat window, type /datafolder.
+This will open a window showing the contents of your data directory. You will
+need to enter the directory (full path) in the profile and hit the 
+save button at the top of the page (cloud with an up arrow in it).
+Once you do this and get a good save (valid data) then you can hit the 
+home button.
+
+If you have ever run the /stats command in game as this Avatar you will
+see you last stats if not, in game write the stats to the chatlog using /stats.
+
+
+## How to check out from github for development
+
+If you wish to modify this code you should fork it on github.
+Instruction on how to use git and github can be found on the web;
+one of the pages on this is 
+[Github Tutorial](http://product.hubspot.com/blog/git-and-github-tutorial-for-beginners)
+
+You can then fork the project and make your edits. You can use your forked version
+just like a release version.
+
+## License
+
+This package is Copyright © 2017 Philip W. Dalrymple III — all rights reserved worldwide
+
+sota-companion is licensed under The Artistic License 2.0
+
+This license establishes the terms under which a given free software
+Package may be copied, modified, distributed, and/or redistributed.
+The intent is that the Copyright Holder maintains some artistic
+control over the development of that Package while still keeping the
+Package available as open source and free software.
+
+You are always permitted to make arrangements wholly outside of this
+license directly with the Copyright Holder of a given Package.  If the
+terms of this license do not permit the full use that you propose to
+make of the Package, you should contact the Copyright Holder and seek
+a different licensing arrangement. 
+
+See the file LICENSE in the root of the distrubtion for the full details.
+

daemon/.gitignore

@@ -0,0 +1 @@
+node_modules