scrabble-cheater
Version:
A simple Scrabble cheating tool.
53 lines (36 loc) • 1.48 kB
Markdown
# ScrabbleCheater [](https://www.gnu.org/licenses/gpl-3.0) [](https://www.npmjs.com/package/scrabble-cheater)
This is a simple Scrabble cheating tool designed for Andy's [scrabble-bot](https://github.com/AndyLnd/scrabble-bot) (but can be used for a normal Scrabble game, too).
Of course you shouldn't be using this and I'm not responsible if people call you a cheater.
## Prerequisites
- [Node.js](https://nodejs.org)
- [yarn](https://yarnpkg.com)
## Setup
ℹ️ This is a pure [ESM](https://nodejs.org/api/esm.html#introduction) module.
```
yarn
yarn dist
```
## Run
```
dist/cli.js
```
## Usage
```
Usage: scrabble-cheater [options]
A simple Scrabble cheating tool.
Options:
-V, --version output the version number
-w, --wordlist <file> Specify a wordlist file (mandatory)
-l, --letters <letters> Specify letters
-q, --quiet Quiet mode: displays only the letters
-m, --maximum <number> Specify a maximum of results
-s, --single Single word mode: displays each word and copies it to the clipboard
-h, --help output usage information
```
## Include in your project
```ts
import {ScrabbleCheater} from 'scrabble-cheater';
new ScrabbleCheater('./my-wordlist.txt', 'l e t t e r s').start().then(matches => {
// [ 'match1', 'match2', ... ]
});
```