Add library code (copied from the demo/website repo https://github.com/Tw1ddle/MarkovNameGenerator)

Author: Tw1ddle

.gitignore

@@ -0,0 +1,12 @@
+*.zip
+*.db
+**/.DS_Store
+**/Thumbs.db
+**/ehthumbs.db
+**/*.lnk
+**/.Trash-*
+**/.directory
+*.hash
+*.map
+lib/dox/themes/samcodes/resources/samcodes-nav.min.css
+lib/dox/themes/samcodes/resources/styles.min.css

CHANGELOG.md

@@ -0,0 +1,29 @@
+## 1.0.0
+* Initial release.
+
+## 1.0.1
+* Add a missed include.xml.
+
+## 1.0.2
+* Fix directory structure so it actually works with haxelib.
+
+## 1.0.3
+* Remove some unused methods and other minor code cleanup.
+
+## 1.0.4
+* Wrote Haxe dox documentation and did some minor code cleanup, mostly removal of unused methods.
+
+## 1.0.5
+* Added regex matching option for filtering generated names.
+
+## 1.0.6
+* Added training data embedding helper macro to the library.
+
+## 1.0.7
+* Added additional utility functions, code cleanup.
+
+## 1.0.8
+* Bug fix for backoff functionality, code cleanup.
+
+## 1.0.9
+* Bug fix to avoid endless loop when prior is greater than 0, code cleanup.

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Sam Twidale (https://samcodes.co.uk/)
+
+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.

README.md

@@ -0,0 +1,30 @@
+# Markov Namegen
+
+Markov Namegen is a Markov chain-based word generator library written in Haxe, made for procedural name generation. Run the demo [here](https://www.samcodes.co.uk/project/markov-namegen/).
+
+## Features
+* Katz backoff using high order models - look up to "n" characters back.
+* Sort and filter generated strings by length, start, end, content and regex matching.
+* Damerau-Levenshtein distance similarity sorting option.
+* Dirichlet prior parameter.
+
+## Usage
+
+See the [demo code](https://github.com/Tw1ddle/MarkovNameGenerator) for a complete worked example. Also read the [documentation here](https://tw1ddle.github.io/MarkovNameGenerator/).
+
+## Markov Namegen Ports
+
+Some users have ported and extended the Markov Namegen library to different programming languages. See:
+
+* Python - [pyMarkovNameGenerator](https://github.com/bicobus/pyMarkovNameGenerator) by [bicobus](https://github.com/bicobus).
+* C# - [ProceduralNameGenerator](https://github.com/MagicMau/ProceduralNameGenerator) by [MagicMau](https://github.com/MagicMau). 
+
+## Tips
+* The generator works by using Markov chains, and requires training data to build them. A hundred or more words within your chosen category is usually sufficient for good results.
+* Sort words by similarity to preferred "good words" using an edit distance metric, and pick the most similar and suitable results. There are a few edit distance measures provided in EditDistanceMetrics.hx.
+* To get best results the training dataset, model order and prior will need to be tweaked for the type of words you want to generate. If possible, keep the prior parameter low or zero. Filter words to suit: look at length, beginning, end, contents, edit distance limits and regex. Some of this done for you in NameGenerator.hx. If you prefer to do it your own way, subclass the Generator class.
+
+## Notes
+* Many of the concepts used for the generator were suggested in [this article](http://www.roguebasin.com/index.php?title=Names_from_a_high_order_Markov_Process_and_a_simplified_Katz_back-off_scheme) by Jeffrey Lund.
+* The haxelib is written in plain Haxe and so supports every Haxe target.
+* If you have any questions or suggestions then [get in touch](https://twitter.com/Sam_Twidale) or open an issue.

dox/.gitignore

@@ -0,0 +1,2 @@
+generated_docs
+types.xml

dox/Main.hx

@@ -0,0 +1,14 @@
+// This is solely for generating documentation for Markov Namegen using dox
+
+import markov.namegen.Generator;
+import markov.namegen.Model;
+import markov.namegen.NameGenerator;
+import markov.util.ArraySet;
+import markov.util.EditDistanceMetrics;
+import markov.util.FileReader;
+import markov.util.IntExtensions;
+import markov.util.PrefixTrie;
+import markov.util.StringExtensions;
+import markov.util.TrainingDataBuilder;
+
+class Main {}

dox/README.md

@@ -0,0 +1,12 @@
+# Markov Namegen Dox
+
+Documentation generation for [Markov Namegen](http://tw1ddle.github.io/MarkovNameGenerator/).
+
+This project generates the Markov Namegen documentation using [dox](https://github.com/HaxeFoundation/dox), the Haxe documentation generator.
+
+## Usage
+
+Run ```generate_docs.sh``` and open ```index.html``` under the ```generated_docs``` folder to see the generated documentation.
+
+## Notes
+When bumping the library version number, remember to update the ```--version``` parameter in ```generate_docs.bat``` to match.

dox/build.hxml

@@ -0,0 +1,5 @@
+-xml types.xml
+-lib sure
+-cp ..
+Main
+--no-output

dox/generate_docs.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# This shell script generates the documentation for markov namegen.
+
+# Clean the generated documentation folder, to remove any old documentation.
+rm -rf "generated_docs"
+
+# Delete any existing generated XML-format type information.
+rm -f types.xml
+
+# Build the XML-format type information.
+haxe build.hxml
+
+# Generate the documentation.
+haxelib run dox -i types.xml -theme ./themes/samcodes --title "Markov Namegen API" -D version 1.0.9 --include "(markov)" -o generated_docs

dox/themes/samcodes/config.json

@@ -0,0 +1,4 @@
+{
+	"name": "Samcodes Theme",
+	"author": "Sam Twidale"
+}