https://github.com/doowb/snake-cli
Experiment / demo using readline-utils to create a simple snake game in the terminal.
https://github.com/doowb/snake-cli
Last synced: about 2 months ago
JSON representation
Experiment / demo using readline-utils to create a simple snake game in the terminal.
- Host: GitHub
- URL: https://github.com/doowb/snake-cli
- Owner: doowb
- License: mit
- Created: 2016-10-21T22:54:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-22T16:43:57.000Z (over 8 years ago)
- Last Synced: 2025-02-24T01:03:37.905Z (2 months ago)
- Language: JavaScript
- Size: 134 KB
- Stars: 21
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# snake-cli [](https://www.npmjs.com/package/snake-cli) [](https://npmjs.org/package/snake-cli) [](https://travis-ci.org/doowb/snake-cli) [](https://ci.appveyor.com/project/doowb/snake-cli)
> Experiment / demo using readline-utils to create a simple snake game in the terminal.
## Install
Install globally with [npm](https://www.npmjs.com/)
```sh
$ npm install --global snake-cli
```
## CLI
When installed globally, this module adds a `snake` command that will start the demo:
```sh
$ snake
```
## API
This module also exports a function that may be called manually to start the demo:
```js
var snake = require('snake-cli');
snake();
```
There are currently no options or configuration. This is just an demo to play around with some [readline-utils](https://github.com/enquirer/readline-utils) features.
## About
### Related projects
* [enquirer](https://www.npmjs.com/package/enquirer): Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all… [more](https://github.com/enquirer/enquirer) | [homepage](https://github.com/enquirer/enquirer "Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all the same prompt types and more, but without the bloat.")
* [readline-ui](https://www.npmjs.com/package/readline-ui): Create readline interface to use in prompts. | [homepage](https://github.com/enquirer/readline-ui "Create readline interface to use in prompts.")
* [readline-utils](https://www.npmjs.com/package/readline-utils): Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more. | [homepage](https://github.com/enquirer/readline-utils "Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more.")
* [repeat-string](https://www.npmjs.com/package/repeat-string): Repeat the given string n times. Fastest implementation for repeating a string. | [homepage](https://github.com/jonschlinkert/repeat-string "Repeat the given string n times. Fastest implementation for repeating a string.")
* [window-size](https://www.npmjs.com/package/window-size): Reliable way to to get the height and width of the terminal/console in a node.js… [more](https://github.com/jonschlinkert/window-size) | [homepage](https://github.com/jonschlinkert/window-size "Reliable way to to get the height and width of the terminal/console in a node.js environment.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](contributing.md) for avice on opening issues, pull requests, and coding standards.
### Building docs
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
$ npm install -g verb verb-generate-readme && verb
```
### Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
### Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](http://twitter.com/doowb)
### License
Copyright © 2016, [Brian Woodward](https://github.com/doowb).
Released under the [MIT license](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 21, 2016._