titlegen

    0.1.2 • Public • Published

    titlegen

    Generate plausible titles from a list of example titles by employing a stupid-simple Markov-Chain approach.

    var generator = titlegen.create();
     
    generator.feed([
      'You Only Live Twice',
      'From Russia with Love',
      'The Man with the Golden Gun',
      'Live and Let Die',
      'Die Another Day'
    ]);
     
    console.log(generator.next()); // -> "From Russia with the Golden Gun"
    console.log(generator.next()); // -> "You Only Live and Let Die Another Day"
    console.log(generator.next()); // -> "The Man with Love"

    This was originally made for generating video game titles (which is why /titles includes many lists of game titles from multiple platforms), but as the example above shows, it can also be used to generate other types of titles.

    Installing

    node.js

    npm install titlegen

    bower

    bower install titlegen
    
    <script src="/bower_components/titlegen/titlegen.js" type="text/javascript"></script>
    

    component

    component install namuol/titlegen
    
    <script src="/components/namuol-titlegen/titlegen.js" type="text/javascript"></script>
    

    API

    var generator = titlegen.create()

    Create a new title generator.

    generator.feed(['Some Title', 'Some Other Title', ...])

    Reset the internal Markov-chain and feed it a list of example titles (array of strings).

    generator.next()

    Generate a new random title and return it as a string.

    generator.config.min_word_count

    Integer; default is 2.

    The minimum number of words a generated title can have.

    generator.config.max_word_count

    Integer; default is 16.

    The maximum number of words a generated title can have.

    generator.config.max_attempts

    Integer; default is 20.

    The maximum number of attempts titlegen will make to generate a title; titles that are too short, too long, or are duplicates of titles from the sample data are discarded.

    generator.config.splitter

    RegExp|String; default is /(\s|'s|[:!?]\s)/

    The argument passed to title.split() to divide a title up into "words".

    generator.config.joiner

    String; default is ' '

    A string used to combine words into titles.

    generator.config.transform

    Function; default removes spaces in front of all instances of :, !, ?, and 's.

    A function that alters the title after its words have been joined with spaces.

    Building

    npm install -g grunt-cli
    npm install
    grunt # titlegen.coffee -> titlegen.js 

    Included Data

    A bunch of video game title lists are included in ./titles/games. These were acquired from Wikipedia.

    If you'd like to add other title list examples (i.e. movies by genre, etc) add a pull request!

    Licenses

    Code: MIT

    Included Title Data: WP:CC-BY-SA

    Install

    npm i titlegen

    DownloadsWeekly Downloads

    14

    Version

    0.1.2

    License

    none

    Last publish

    Collaborators

    • namuol