generator-twitch-irc

This project includes

Yeoman generator by Yeoman Team

Twitch-IRC library by Schmoopiie

Twitch is a trademark or registered trademark of Twitch Interactive, Inc. in the U.S. and/or other countries. "Twitch-IRC" is not operated by, sponsored by, or affiliated with Twitch Interactive, Inc. in any way.

What is Yeoman?

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

$ npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-twitch-irc from npm, run:

$ npm install -g generator-twitch-irc

Finally, go into your project root directory and initiate the generator:

$ yo twitch-irc

Getting to know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

Updating your Generators

It is important for you to update from time to time your generators. Basically, all you need to to is type a simple word in your command prompt:

$ yo

Updating your Twitch-IRC library

Go into your project root directory and type:

$ yo twitch-irc

Generating Events

Generated events will be created in your events directory and will be loaded on startup.

$ yo twitch-irc:event <event name>

Click here for the events documentation.

Generating Commands

Generated commands will be created in your commands directory and will be loaded on startup.

$ yo twitch-irc:command !<command name>

Only the basic code will be written for you.

Using Twitch Commands

You can use all the Twitch commands with your bot.

Click here for the commands documentation.

Database

Create collections and interact with them like any database management system. Your collections will be saved in your database directory previously generated by the generator.

Click here for the database documentation.

Contributing Guidelines

Please review the guidelines for contributing to this repository.

License

The MIT License (MIT)

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 NON INFRINGEMENT. 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.

l0sth/generator-twitch-irc