Skip to content

Java library to generate random, English pronounceable words.

License

Notifications You must be signed in to change notification settings

maximeroussy/invitrode

Repository files navigation

logo

A Java/Android library to generate random english pronounceable words based on a collection of constructed bi-grams.

MIT License GitHub release

Summary

This is a lightweight and focused library. There's a single class with only a single public method that's accessible.

This library can be used in an infinite amount of ways:

  • generate initial passwords for your user based applications
  • suggest character names in your games
  • find a unique name for your child
  • the list goes on...

Demo

Here's a simple Android app built with the library that demonstrates its usage:

This demo app is available on Google Play.

Download/Install

The library is available through Maven Central, which is included in your repositories by default on Android. For a Java project, make sure you have mavenCentral() added to your repositories.

Gradle (preferred):

implementation 'com.maximeroussy.invitrode:invitrode:2.0.2'

Maven:

<dependency>
  <groupId>com.maximeroussy.invitrode</groupId>
  <artifactId>invitrode</artifactId>
  <version>2.0.2</version>
  <type>pom</type>
</dependency>

Manual

You can grab the jar for the latest release to include in your project manually.

Usage

Using the library is extremely simple.

WordGenerator generator = WordGenerator();
String myNewWord = generator.newWord(int lengthOfWord);

Inspiration & Credits

Bi-gram source and general concept based on Scrollback's generate.js & described in this blog post by Aravind. This is a Java adaptation that will be further developed as a functional and feature rich random word generator.

License

The MIT License (MIT)

Copyright (c) 2022 Maxime Roussy

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.

About

Java library to generate random, English pronounceable words.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages