Your useful handbook
1. Syntax
1.1 >
The ">" symbol, is used to mark the end of a keyword, and the start of the input.
1.2 |
The "|" symbol, is used to seperate input values. All keywords, other than "alphabet", will require
these symbols to seperate input.
2. Keywords
2.1 alphabet:
This is a list of letters that will be used in the words. If there is a letter that doesn't appear here,
that does not mean it won't appear in the generated words.
In this example, there are "abcdefg" in the alphabet.
start>abcdefg
2.2 start:
This is a list of letters that will start each word.
In this example, every word will always start with "a", "abc", or "de".
start>a|abc|de
2.3 rules:
This is a list of rules that will be applied to each word, either while generating, or after generating.
This list can be left empty.
2.4 caps:
If a word ends with a vowel, then a random word from this list will be added to the end.
This list can be left empty.
2.5 min:
The minimum amount of iterations to use in each word.
2.6 max:
The maximum amount of iterations to use in each word.
2.7 max:
Every vowel to be used. This is a list that will tell the keyword processer what letters are vowels, and
what isn't.
2.8 other keywords:
Other keywords are kind of like tree branches. If the last letter in an iteration was "a", and this
keyword contains a, then it picks a random letter, or sequence from this list to add to the word.
In this example, if the last letter was "a", "b", or "c", then the next letter will be "d", "e", or "f".
abc>d|e|f
3. Rules
2.1 clamp_two:
This rule makes sure that there are a maximum of two vowels, or consonants consecutively.
2.2 trim_vowels
This rule tries to make sure that there are no repeating vowels.
2.2 trim_consonants
This rule tries to make sure that there are only one consonant to begin.
2.2 no_duplicated_vowels
This rule tries to make sure that there are no repeating vowels. To avoid confusion:
heello >> trim_vowels - remove the repeating "ee".
salad >> no_duplicated_vowels - turn the second "a" in "salad" to something else, even if it's a valid word.
2.2 no_duplicated_consonants
This rule is the same as no_duplicated_vowels, except it checks for consonants.