Skip to content

Latest commit

 

History

History
129 lines (108 loc) · 5.62 KB

README.md

File metadata and controls

129 lines (108 loc) · 5.62 KB
Raw

Nuget

What is this?

  • Syllabore is a procedural name generator that does not use pre-made lists of names
  • It can be embedded into a .NET program and used 100% offline

How are names generated?

  • Syllabore first constructs syllables out of characters (graphemes)
  • Then it sequences syllables into names

Table of Contents

  1. Quick Start
  2. Tailoring Characters
  3. Transformations
  4. Filtering
  5. Installation
  6. Compatibility
  7. License

Quick Start

Use the NameGenerator class to generate names. Call Next() to get a new name. By default, a subset of consonants and vowels from the English language will be used.

var g = new NameGenerator();
Console.WriteLine(g.Next());

This will return names like:

Pheras
Domar
Teso

Tailoring Characters

For simple generators, you can supply the vowels and consonants to use through the constructor:

var g = new NameGenerator("ae", "srnl");

Names from this generator will only ever have the characters a and e for vowels, and the characters 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!

Transformations

A Transform is a mechanism for changing a source name into a new, modified name. Call UsingTransform() on a NameGenerator to specify one or more transformations:

var g = new NameGenerator()
        .UsingTransform(x => x
            .ReplaceSyllable(0, "zo") // Replace the first syllable with string "zo"
            .AppendSyllable("ri"));   // Adds a new syllable to end of name

Calling Next() produces names like:

Zocari
Zoshari
Zojiri

See the wiki for additional examples.

Filtering Output

Each NameGenerator can be configured to prevent specific substrings or patterns from showing up in names. Filtering is completely optional, but is useful in avoiding awkward sounding combinations of characters.

Here is a basic example of preventing substrings from appearing:

var g = new NameGenerator()
        .DoNotAllow("ist") // Will prevent names like "Misty"
        .DoNotAllow("ck"); // Will prevent names like "Brock"

See the wiki for additional examples.

Installation

.NET apps

Syllabore is available as a NuGet package. You can install it from your NuGet package manager in Visual Studio (search for "Syllabore") or by running the following command in your NuGet package manager console:

Install-Package Syllabore

Godot Engine

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, cd into your Godot project directory, and use the following command:
dotnet add package Syllabore

Compatibility

By design, Syllabore is a .NET Standard 2.0 class library. This means it will be compatible with applications using:

  • .NET or .NET Core 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0
  • .NET Framework 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
  • Mono 5.4, 6.4

Syllabore has been tested and known to work in the following game engines:

  • Godot 4 (Using the .NET edition of the engine)

Syllabore should also work in the following game engines, but I have not done adequate testing yet:

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.