Lion is a plugin-oriented Discord bot that utilizes Discord.js and TypeScript. Lion was created originally to satisfy the needs of server automation within the UCF CS Discord.

Getting Started

The simplest way to get started off with developing the Lion codebase is by cloning the project: git clone https://github.com/joey-colon/lion

Install dependencies via NPM: npm install

Create a .env file within the root directory of the project (reference the .env.sample sample file) with your Discord application token: DISCORD_TOKEN=your_token_here

Execute the following command to launch Lion: npm run watch

All subsequent saved changes made within the /src directory will make Lion automatically rebuild while the watch command is running.

Your first plugin

Navigate to the /src/app/plugins directory and create a new file following the specific schema: example.plugin.ts

For ease of use, it's recommended that your plugin name is in all lowercase and in snake_case.

Here's a skeleton for how a basic plugin should look:

import { Plugin } from '../../common/plugin';
import { IContainer, IMessage, ChannelType } from '../../common/types';

export class ExamplePlugin extends Plugin {
  public name: string = 'Example Plugin';
  public description: string = 'An example plugin to show how awesome Lion is!';
  public usage: string = 'example';
  public permission: ChannelType = ChannelType.Bot;

  constructor(public container: IContainer) {
    super();
  }

  public async execute(message: IMessage, args?: string[]) {
    // Your logic here.
  }
}

Again, this is a basic skeleton. It is suggested to read the abstract Plugin class to fully know what is possible within a plugin, which is located in /src/common/plugin.ts.

After creating your new plugin class, there's one step left. We will need to add it to the PluginStore. Navigate over to /src/bootstrap/plugin.loader.ts. Simply add your plugin to the PluginStore object:

const PluginStore: { [pluginName: string]: any } = {
  ...,
  ...,
  example: ExamplePlugin,
}

And that's it! You have successfully created your first plugin with Lion!

gooca/lion

Getting Started

Your first plugin