molecube

1.0.0 • Public • Published

Contributors Forks Stargazers Issues MIT License


Logo

molecube

A command line application to make discord.js easier!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Product Name Screen Shot

molecube is a simple Command Line Application written in NodeJS. It helps you generate discord.js bots. Again, this is a discord bot generator, not a bot itself. Its configuration is saved in molecube.json.

molecube offers you:

  • Creating a project in discord.js
  • A command handler
  • A event handler
  • Easly generate events with its documentation links
  • Easly generate commands
  • Conection to a database
  • Simplicity

Full Changelog: https://github.com/raining-codes/molecube/commits/Release

(back to top)

Getting Started

Installing molecube is pretty easy and straightforward.

Installation

To use with yarn do:

yarn global add molecube

To use with npm do:

npm install -g molecube

(back to top)

Usage

Making a new bot

To make a new discord bot using molecube, open terminal in your preffered location and type molecube new. This will ask you a couple of questions, These questions are:

  1. Bot name
  2. Your preffered language
  3. Your package manager
  4. Your bots token
  5. Your MongoDB Database URI (If you don't have a database just skip this)

After you've answered these questions, molecube will create a new folder and create a simple ping slash command.

Generating events or commands

To add your own custom commands and events, you need to follow these instructions.

  1. Open terminal in a molecube project directory.
  2. Run molecube gen, this will ask you to generate a event or command.
  3. Select your option and press enter.

If you selected event, theres gonna be list of all events and you can create multiple events at once. Your generated event files are gonna be located in src/events.

If you selected command, it will ask for command name and description. Command file will be located in src/commands

For more examples, please refer to the Documentation

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Your Name - George Tskitishvili

Project Link: https://github.com/raining-codes/molecube

(back to top)

Readme

Keywords

none

Package Sidebar

Install

npm i molecube

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

65.8 kB

Total Files

37

Last publish

Collaborators

  • george-tskiti