Skip to content
A Discord bot framework built on top of discord.js
TypeScript Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.buildkite
.vscode Update project configurations Aug 7, 2019
src Add support for hidden commands Aug 21, 2019
.editorconfig Add .gitignore, .editorconfig, LICENSE Mar 29, 2019
.gitignore Remove redundant WorkerClient class, add loadCredentials method May 5, 2019
.travis.yml Update travis node version Apr 9, 2019
CHANGELOG.md
LICENSE Add .gitignore, .editorconfig, LICENSE Mar 29, 2019
README.md Update README.md Aug 18, 2019
package-lock.json Add support for hidden commands Aug 21, 2019
package.json v1.2.0 Aug 21, 2019
test-runner.js Remove the need for ts-node Apr 9, 2019
tsconfig.json Update project configurations Aug 7, 2019
tsconfig.prod.json Update project configurations Aug 7, 2019
tslint.json

README.md

Build Status

NPM

Disharmony

A Discord bot framework built on top of discord.js with command parsing and basic Mongo-like database integration

Features

  • Built on top of discord.js
  • Command handling
    • Syntax parsing
    • Per-server configurable prefix
    • Permission levels
  • Basic default commands
    • Help menu
    • Statistics
    • Version number
  • Mongo-like database support
  • Extensible

Use cases

  • Create bots without bothering with boilerplate
  • Focus on bot features rather than discord/database integrations
  • Reduce the amount of similar code between bots

Examples

Development

Prerequisites

Setup

  • npm install to install dependencies
  • tsc to compile JS into dist/

Tests

  • Written in TypeScript using Alsatian
  • Run with npm test

CI setup

  • The repository is configured for CI using Buildkite

  • Pipelines are stored in .buildkite and should be loadeg using Buildkite's 'read from repository' step

  • The standard pipeline deals with linting, building and running tests

  • The publish pipeline will publish the package to NPM when triggered

    • The Buildkite agent must have an NPM auth token set in the NPM_AUTH_TOKEN environment variable
  • Docker and Git must both be installed on the Buildkite agent

  • If running the agent on Windows, a couple of extra configuration steps need to be performed

    • The drive the Buildkite agent writes to needs to be shared with Docker
    • Git's /bin folder needs to be in the PATH
    • Git's global config option core.autocrlf needs to be set to false (as the files are used in a Linux docker image)

Built With

Documentation

Versioning

SemVer is used for versioning; view available versions on the tags page

License

This project is licensed under the MIT License - see the LICENSE file for details

You can’t perform that action at this time.