MarkovGrams/README.md

59 lines
4.1 KiB
Markdown
Raw Permalink Normal View History

2017-04-26 20:36:18 +00:00
# MarkovGrams
2017-05-19 11:20:08 +00:00
Experiments into markov chains, n-grams, and text generation. This repository is the result of the markov chain blog post mini-series on my blog.
2017-05-19 11:19:41 +00:00
- [Part 1 - n-grams](https://starbeamrainbowlabs.com/blog/article.php?article=posts/236-Markov-Chain-Part-1-N-Grams.html)
- [Part 2 - unweighted markov chains](https://starbeamrainbowlabs.com/blog/article.php?article=posts%2F238-Markov-Chains-Part-2-Unweighted-Chains.html)
2019-02-07 10:57:15 +00:00
- [Markov Chains Part 3: Weighted Chains](https://starbeamrainbowlabs.com/blog/article.php?article=posts/285-Markov-Chains-Part-3-Weighted.html)
- [Markov Chains Part 4: Test Data](https://starbeamrainbowlabs.com/blog/article.php?article=posts/323-MarkovGrams-Part-4-Test-Data.html)
## Building
2017-05-18 12:11:51 +00:00
Building this project should be easy - I can provide prebuilt binaries upon request though if asked (see [my website](https://starbeamrainbowlabs.com/) for contact information).
### Windows
Open the solution in Visual Studio / MonoDevelop and hit build.
### Linux and everyone else
As above with MonoDevelop, or simply use the command `xbuild` whilst inside the root of the repository.
2017-05-18 12:11:51 +00:00
## Using
Detailed usage help can be seen by simply running the tool without any arguments:
```bash
./MarkovGrams.exe
```
Linux users might need to explicitly run it with `mono`:
```bash
mono ./MarkovGrams.exe
```
2018-09-02 21:36:53 +00:00
## Wordlists
The `wordlists/` directory contains a few interesting wordlists I used when writing and testing this program.
Filename | Contents | Comments
----------------|--------------|------------------
`Colours.txt` | List of colours | Built with a sneaky bit of Javascript in the developer tools of [this webpage](http://www.colorhexa.com/color-names) from [colorhexa](http://www.colorhexa.com/), which turns out to be a really useful website about colours.
2018-10-25 22:59:11 +00:00
`Science Words.txt` | List of cool sciencey-type words | Compiled from scratch by [Starbeamrainbowlabs](https://starbeamrainbowlabs.com/) - that's me! This list falls under the _Mozilla Public License 2.0_, as described below in the [license section](https://git.starbeamrainbowlabs.com/sbrl/MarkovGrams#license).
2018-09-02 21:36:53 +00:00
`Cross-Code-Items.txt` | List of items in _[Cross-Code](http://cross-code.com/)_ | A list of all items in the game _CrossCode_. Scraped from [here](https://crosscode.gamepedia.com/Items) by a clever bit of bash in `wordlists/download.sh`. I obviously don't own any of these names.
`Final-Fantasy-15-Items.txt` | List of items in _[Final Fantasy 15](https://finalfantasyxv.square-enix-games.com/)_ | Another list of in-game items - this time from _Final Fantasy XV_. Scraped from [this wiki page](http://finalfantasy.wikia.com/wiki/List_of_Final_Fantasy_XV_items) and related pages. The even cleverer bit of bash that does this is also in `wordlists/download.sh`. Again, I don't own any of these :-)
2018-09-02 21:51:13 +00:00
`No-Mans-Sky-Items.txt` | List of items in [No Man's Sky](https://www.nomanssky.com/) | Yep, you guessed it. Don't own this. Bash available in `wordlists/download.sh` - I had a bit of trouble with this one, and had to use an awkward hack or two.
2018-10-25 14:34:31 +00:00
`Starbound.txt` | List of blocks and items in [Starbound](https://playstarbound.com/) | From the [Official Wiki](https://starbounder.org/) - I don't own it, I just wrote the scraper :P
2018-09-02 21:36:53 +00:00
2019-02-07 10:57:15 +00:00
### Candidates
The following pages & websites looks like they show promise, but I haven't imported them yet.
- [List of fictional newspapers](https://en.wikipedia.org/wiki/List_of_fictional_newspapers)
## Credits
2018-09-02 21:36:53 +00:00
- The code was written by [Starbeamrainbowlabs](https://starbeamrainbowlabs.com/) - that's me too!
- I found the [Markov Chain Text Generation](http://nullprogram.com/blog/2012/09/05/) post by [Chris Wellons](http://nullprogram.com/) rather useful when writing this.
2019-02-07 10:57:15 +00:00
- Wordlists - See the table above
2018-10-25 22:58:44 +00:00
## License
This repository (except where stated above - the wordlists except the science words) is licensed under the _Mozilla Public License 2.0_ (_MPL-2.0_). A copy of the license text can be found in the [LICENSE file](https://git.starbeamrainbowlabs.com/sbrl/MarkovGrams/src/branch/master/LICENSE) in this repository, and tldr-legal have [a summary](https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)) if you can't speak legalese :-)