Git Product home page Git Product logo

dubbot-starter's Introduction

Dubbot Starter

dubtrack.fm starter bot using DubAPI.

Bots using this:

Installation and Running

  1. git clone https://github.com/NitroGhost/dubbot-starter.git

  2. npm install

  3. Setup your config.mine.js file. example:

module.exports = {
	botName: "dubbot",
	botPass: "justADubbotPassword",
	roomURL: "dub-bot"
};
  1. Add commands in the /app/bot/commands file with the name of the command. example: ping.js. Any file added to the commands folder will be auto required on startup and caches the name of the file so that it can be called when sending the command in the chat. If you want the file to be called by more than just the file name, then you can define an array of extra commands by setting module.exports.extraCommands to an array of strings. I have already added a few simple commands in the commands folder to get you started.

  2. You can add more events listeners in the events folder and add your code on what you want it to do on that event. The convention that I went for with my own bot was to name the file with the name of the event such as room_playlist-update.js so that you know what the file does. As far as the bot is concerned, the file name does not matter, unlike the file names in the commands folder.

  3. Run the bot with npm run bot. this will gulp mine which copies your config.mine.js file to config.js then node ./app/bot/index.js to start the bot

TODO:

write up how to host your bot using openshift which will explain why there is a "sever" side to the bot. Will also explain the extra scripts found in the package.json files and how to use them.

dubbot-starter's People

Contributors

benwildeman avatar coryshaw1 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.