https://github.com/fluorine/conlangwordgenerator
A statistical random words generator for constructed languages.
https://github.com/fluorine/conlangwordgenerator
conlangs constructed-language esperanto language linguistics phonemes ruby
Last synced: 2 months ago
JSON representation
A statistical random words generator for constructed languages.
- Host: GitHub
- URL: https://github.com/fluorine/conlangwordgenerator
- Owner: fluorine
- License: apache-2.0
- Created: 2013-06-21T22:37:07.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-08-12T02:34:31.000Z (almost 12 years ago)
- Last Synced: 2025-03-24T13:17:07.122Z (3 months ago)
- Topics: conlangs, constructed-language, esperanto, language, linguistics, phonemes, ruby
- Language: Ruby
- Homepage:
- Size: 176 KB
- Stars: 21
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
ConlangWordGenerator, v0.3.1
============================
**Now it's a gem!**
Description
-----------
This gem allows the user to generate words for
constructed languages, given a LANG file that
describes the language. It can also be useful
for linguistics to study and generate valid words
from a descripted language.
The `*.lang` file must include sets of phonemes with
their individual probability weight, and a grammatical
expression, to describe how to generate words for the
described language.
Instructions
------------
Usage as a **command line executable**:
conlang ''
This command produces an `output-.txt`
file that includes a list of the generated words,
separated by newlines.
Usage as a **gem**:
require 'conlang'
# Path to LANG file, as constructor.
x = WordGenerator.new("tokipona.lang")
# Print ten generated words as
# an array of strings.
p x.get_words(10)
There are `*.lang` files as examples at `lang-examples`
directory of this [project's source](https://github.com/fluorine/ConlangWordGenerator).
Custom .lang files
------------------
You must create your own .lang files to generate random
words for your constructed languages.
There files include a simple lightweight markup language
to describe sets of phonemes, their probability, replacements
(for exceptions) and a simple regular grammatical expression.
You can learn how to create LANG files [**here**](LANG_FILES_DOC.md).
Again, examples at `lang-examples` directory can help you a lot.
The class `WordGenerator` takes a path to a valid `*.lang`
file to produce a generator of words, as described previously
in the **Instructions** section.
Root-level identifiers
----------------------
- **WordGenerator** - Main class
- **ConlangWordGenerator** - Namespace module for the gem
- Exceptions
- **LangFileError** < StandardError, for LANG files
- **LangFileIOError** < LangFileError
- **LangSyntaxError** < LangFileError