GithubHelp home page GithubHelp logo

kesac / syllabore Goto Github PK

View Code? Open in Web Editor NEW
36.0 6.0 2.0 423 KB

A fantasy name generator that does not use pre-made lists of names

License: MIT License

C# 100.00%
name-generation generation syllable syllables fantasy name name-generator fantasy-name namegeneration namegenerator

syllabore's People

Contributors

kesac avatar monerofglory avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

syllabore's Issues

Add Contribution Framework

I think this project would benefit with a way to get in touch to make contributions towards this public repository.

For example, I would like to contribute some Unit Test refactorings that I have made to the NameGeneratorTests.cs. How can we get in touch to request permission from you and permissions within GitHub to open a PR with changes for you to review.

Update to .NET 8

Though you have recently upgraded to .NET 7, .NET 8 has recently released and is the new "long term support" option from Microsoft. Given the last jump was .NET 5 -> .NET 7, it may be worthwhile to update to the latest, long-term support solution.

Documentation for .Invalidate

In the latest stable NuGet version 1.1.0, .Invalidate gives Compiler error: 'NameValidator' does not contain a definition for 'Invalidate' and no accessible extension method 'Invalidate' accepting a first argument of type 'NameValidator' could be found (are you missing a using directive or an assembly reference?)

I switched to .DoNotAllowPattern but wanted to note this for the documentation. Also thanks for Syllabore! It's extremely useful!

Release version 2.4 on NuGet

Problem Space
I recently wanted to demonstrate a release version of Syllabore to a friend, but noticed that the latest version on NuGet was 2.3.1 released on October 11th 2023. There have since been many commits/features added!

What is your idea?
If you still wish to release your package via NuGet (the prerogative of the maintainer, of course), you should release a new version for use, especially with your new .NET 8 changes.

If you do not desire to maintain packages on NuGet, feel free to close this issue.

How will this benefit users of Syllabore?

  • It allows users to access up-to-date features and improvements.

A replacement for OfTrailingConsonantIsSequence function

Cheers, just getting started with Syllabore but want to express my appreciation for the authors' work. So far this solution fits my needs the best of all I could find on Github.

This might be a mix of general questions and bug reports here, so I may split them into distinct issues.
I did read all the guides on the wiki. My version is 2.3.2.

  • So, in order to control last syllable's coda cluster I tried to set the probability for trailing consonants at 1 using the deprecated OfTrailingConsonantIsSequence function, since this is the only function I found which is able to configure that. Documentation suggests to use OfTrailingConsonants but then it appears to me I'm unable to assure the syllable does end with a coda cluster at all.

A side question there:

  • Should a SyllableGenerator with no vowel graphemes provided return an empty string? Also guide 1.1.2 mentions that onset and coda are optional, is that from a linguistic perspective or it is intended to be a constraint for SyllableGenerator?
    Are vowels intended to be mandatory to specify for SyllableGenerator to function?
    If I have no probabilities specified for SyllableGenerator making coda cluster to occur all the time, I get an exception due to an empty string generated as a result.

  • Also I noticed that when I try to override DefaultSyllableGenerator (and SyllableGenerator as well) trailing consonant cluster without specifying the probability, it never returns a syllable containing the coda cluster specified. (And in case of Syllable generator, an empty string is returned as mentioned above).

And tiny remarks for the guides:

  • 3.1 Section has a typo?
    Quote: "Names with three or more consonants in a row look are also difficult to read. Our NameFilter allows use to also identify patterns we want to avoid through regular expressions:"
  • At the end of the section a deprecated UsingProvider method is being used.

Thanks for your time!

[Feature Request] More Examples

Hey kesac,

Syllabore is a fantastic tool and works great, thanks a lot for creating it!

I'm having a hard time coming up with the right settings for specific requirements (lack of knowledge how language actually works) and was wondering if you (or someone else) is planning on adding more basic examples to help people getting a generator up and running? The examples that are already in the repo are great but a few more would be even better :)

Some ideas:

  • First name
  • Surname
  • Space ship name
  • Planet name
  • Animal name
  • Weapon name
  • ...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.