zTest
- Syllabore is a procedural name generator that does not use pre-made lists of names
- It can be embedded into a .NET program or game, and used 100% offline
- Instantiate a
NameGeneratorclass and make calls toNext()to get new names
var g = new NameGenerator();
Console.WriteLine(g.Next());- This will return names like:
Pheras
Domar
Teso
- By default, a subset of consonants and vowels from the English language will be used
For simple generators, you can specify vowels and consonants through the constructor:
var g = new NameGenerator("ae", "srnl"); Names from this generator will only use a and e for vowels, and s r n and l for consonants. Calls to Next() will produce names like:
Lena
Salna
Rasse
See the wiki for more examples on how to control things like vowel sequences, consonant positioning, and more!
Syllabore first constructs syllables then sequences them into names. For more granular control, initialize a SyllableGenerator first.
## Other Features **Syllabore** provides support for the following: - [Graphemes](#) - a way to control whether your characters are lead a syllable, trail a syllable, form a clusters, etc. - [Transforms](#) - a way to transform existing names into new ones - [Filters](#) - a way to prevent substrings from appearing in names - [Weights](#) - a way to manipulate the probability that specific characters will be used
## Installation ### .NET apps For .NET apps, Syllabore is available as a [NuGet](https://learn.microsoft.com/en-us/nuget/what-is-nuget) package. You can install it from your [NuGet package manager in Visual Studio](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio) (search for "Syllabore") or by running the following command in your NuGet package manager console: ``` Install-Package Syllabore ```
There are a couple ways to do this in Godot:
- Open your Godot project in Visual Studio and add the Syllabore NuGet package through the package manager
- Or open a command line,
cdinto your Godot project directory, and use the following command:
dotnet add package Syllabore
## Compatibility By design, Syllabore is a [.NET Standard](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-1-0) 2.0 class library. This means it will be compatible with a number of .NET distributions and game engines. See a complete list [here](#). ## License ``` MIT License
Copyright (c) 2019-2024 Kevin Sacro
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.