Code Monkey home page Code Monkey logo

komada-docs's Introduction

Komada Framework Documentation

Discord npm npm Build Status David

Komada is a modular framework for bots built on top of Discord.js. It offers an extremely easy installation, downloadable commands, and a framework to build your own commands, modules, and functions.

What's with the name?

Komada is the Croatian word for "pieces", such as puzzle pieces. As usual to find my software name I just shove english words in a translator and see what comes out. But why "pieces"? Because Komada is modular, meaning each "piece" is a standalone part that can be easily replaced, enhanced, reloaded, removed.

Installing Komada

Time to take the plunge! Komada is on NPM and can be easily installed.

I assume you know how to open a command prompt in a folder where you want to install this. Please don't prove me wrong.

npm install --save komada

Create a file called app.js (or whatever you prefer) which will initiate and configure Komada.

const komada = require('komada');
komada.start({
  "botToken": "your-bot-token",
  "ownerID" : "your-user-id",
  "clientID": "the-invite-app-id",
  "prefix": "+",
  "clientOptions": {
    "fetchAllMembers": true
  }
});

Configuration Options

  • botToken: The MFA token for your bot. To get this, please see This discord.js Getting Started Guide, which explains how to create the bot and get the token.
  • ownerID: The User ID of the bot owner - you. This gives you the highest possible access to the bot's default commands, including eval! To obtain it, enable Developer Mode in Discord, right-click your name and do "Copy ID".
  • clientID: The bot's client ID obtained from the same place you got the token. It's at the top of the page!
  • prefix: The default prefix when the bot first boots up. This option becomes useless after first boot, since the prefix is written to the default configuration system.
  • clientOptions: These are passed directly to the discord.js library. They are optional. For more information on which options are available, see ClientOptions in the discord.js docs.

For all you selfbot users out there, you can add a option ('selfbot': true) to have Komada enabled for selfbot usage. i.e. only respond to commands from you.

Running the bot

Then, run the following in your folder:

npm install
node --harmony app.js

Requirements: Requires Node 7 or higher to run. Depends on Discord.js v11 or higher (the appropriate version is automatically installed).

komada-docs's People

Contributors

cyberiumshadow avatar eslachance avatar fog-yamato avatar gitbook-bot avatar unseenfaith avatar

Watchers

 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.