Skip to content

CompeyDev/codenamer.luau

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

codenamer.luau

A library for generating unique an memorable codenames, inspired by the NPM library unique-names-generator.

Includes out-of-the-box dictionaries, but custom dictionaries can also be provided for special use-cases.

Uses a simple mullbery32 implementation for pseudorandom number generation under the hood, which makes it unlikely for duplicate codenames in a row.

Usage

See examples for a variety of examples exploring various functionalities of the library. In order to run a specific example, refer to development.

Development

This library is intended to be used with lune, a standalone Luau runtime.

Due to the current state of wally, installing packages on lune is not successful by default. This project includes a dependency installation script, which can be used to set up a development environment. The script is platform independent.

Running Examples

Once the development environment has been set up, build the minified package bundle by running bundle-prod.sh.

Examples can now be run using lune:

lune examples/EXAMPLE.luau

where EXAMPLE is to be replaced with the name of the example in the examples directory.

About

A Luau library for generating interesting codenames.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published