Maxime Roussy

logo

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

MIT License Jitpack Release Star

Summary

This is a lightweight and focused library. The Java class currently only includes 6 methods. More features are planned that will obviously add to the method count in the future.

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

Demo

Here’s a simple Android app built with the library that demonstrates it’s usage:

Usage

Using the library is extremely simple.

try {
  String myNewWord = RandomWord.getNewWord(int lengthOfWord);
} catch(Exception e) {
  //handle exception
  //the method getNewWord can throw a WordLengthException when the length chosen is outside of the current limits (between 3 and 15 characters)
}

Downloads

Gradle (preferred):

Add the jitpack repository:

repositories {
  maven { url "https://jitpack.io" }
}

dependencies {
  compile 'com.github.maximeroussy:invitrode:1.0.10'
}

Maven:

Then add the Maven dependency:

<repository>
	<id>jitpack.io</id>
	<url>https://jitpack.io</url>
</repository>

<dependency>
	<groupId>com.github.maximeroussy</groupId>
	<artifactId>invitrode</artifactId>
	<version>1.0.10</version>
</dependency>

Manual:

The alternative method is downloading the latest JAR to include yourself in your projects.

Inspiration & Credits

Why the name Invitrode? Why make a random word generator? This should suffice: https://www.youtube.com/watch?v=hsr-QfgFRh8

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) 2017 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.