mouse484 / Ecstar

The easiest JavaScript/TypeScript Discord bot framework.

Home Page:http://ecstar.js.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

image

Ecstar

ESLint badge document badge npm version npm download github starts LICENC discord.js version discord Gitpod Ready-to-Code

📃Introduction

Ecstar is the easiest framework Discord.js.

📖Document

https://ecstar.js.org

📥Installation

Install Ecstar using npm or yarn.

npm install ecstar
yarn add ecstar

💬Usage

📄Main File

/index.js

const { Client } = require('ecstar');

const client = new Client(options);

client.login('Your token here');

options: EcstarOptions

📄Command File

/commands/filename.js

const { Command } = require('ecstar');

module.exports = class extends Command {
  constructor(client) {
    super(client, options);
  }

  run(message) {
    // What to do
  }
};

options: commandOptions

📄Event File

/events/filename.js

const { Event } = require('ecstar');

module.exports = class extends Event {
  constructor(client) {
    super(client, 'Receive event name');
  }

  run(/* callback here */) {
    // What to do
  }
};

📄Args File

/args/filename.js

const { Args } = require('ecstar');

module.exports = class extends Args {
  constructor(client) {
    super(client, 'args name');
  }
  run(message){
    // What to do
  }
};

📄Lang File

const { Lang } = require('ecstar');

module.exports = class extends Lang {
   LOADING_COMMANDS = '';
   ...
};

See Here

🎫License

👀Author

About

The easiest JavaScript/TypeScript Discord bot framework.

http://ecstar.js.org

License:MIT License


Languages

Language:TypeScript 97.5%Language:JavaScript 2.4%Language:Dockerfile 0.2%