Username Generator

About the Project

This repository contains a set of user interfaces to randomly generate customized usernames. These usernames are collated in a title-case format (e.g. "WordWord") with greater customization such as character count and number of syllables per word.

Note for using filters: Filtering by syllable counts may occasionally be off by one, as English is a language that often doesn't play by a consistent set of phonetic rules. This makes it tricky to detect the number of syllables using an algorithm.

Applications

Console

Terminal UI

Web

Desktop

Getting Started

Prerequisites

• .NET 8 SDK: https://dotnet.microsoft.com/en-us/download/dotnet/8.0

Installation

1. Clone the repo:

   git clone https://github.com/gridlocdev/UsernameGenerator.git
   

2. Open the directory of the app you would like to run (e.g. UsernameGenerator.Console)

   cd UsernameGenerator.Console
   

3. Run the application

   dotnet run
   

Using your own word list

1. Create a fork of this repository
2. Clone your new fork of the repository down to a folder on your local machine
3. In the UsernameGenerator.Core directory, edit the file named ./Data.words.txt to include your own word list
4. Create a new Console app project
5. In the csproj file, add a reference to the UsernameGenerator.Core project

   <ItemGroup>
     <ProjectReference Include="..\UsernameGenerator.Core\UsernameGenerator.Core.csproj" />
   </ItemGroup>

6. Replace the contents of Program.cs with the following

   using UsernameGenerator.Core;
   
   SyllableWriter.WriteToJson();

7. Run the new Console app

   dotnet run
   

License

Distributed under the GPL-3.0. See the LICENSE file for more information.

Acknowledgements

• Online Plain Text English Dictionary (OPTED)
• EddyDN's OPTED export