Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.56 KB

README.md

File metadata and controls

79 lines (56 loc) · 2.56 KB

Jishacum

Jishacum is a debugging and testing container for discordrb bots.

Jishacum is heavily inspired by Jishaku (a debugging and testing cog for discord.py bots).

Jishacum is aliased as jsc.

Jishacum Features Preview

Features

jishacum | jsc

Show some information about the bot.

jsc debug | dbg [command] [*args]

Debug a command.

jsc eval | e [code]

Evaluate a code. You can see the shortcut variables in the EVAL_SHORTCUTS file.

jsc exec [member_id] [command] [*args]

Execute a command as someone else.

jsc repeat | rpt [number] [command] [*args]

Repeat a command in the specified number times.

jsc restart | r

Restart the bot.

jsc run [ruby_code]

Run a Ruby code (e.g. jsc run puts "hello").

jsc shell | sh [command_line]

Run a command line in the shell.

jsc shutdown | exit

Shut down the bot.

Jishacum Installation

Obviously, you must have a ready discordrb bot with Bundler to use jishacum.

  1. $ git clone https://github.com/danrfq/jishacum
  2. $ cd jishacum
  3. $ bundle install

After installing the bundle, you must set OWNER_ID or OWNER_IDS (if your bot is owned by a team) in the config file. Otherwise, jishacum will not run.

# before 

"OWNER_ID" => nil,

# after

"OWNER_ID" => 211756205721255947,

# or with OWNER_IDS

"OWNER_ID" => nil,
"OWNER_IDS" => [],

# after

"OWNER_ID" => nil,
"OWNER_IDS" => [211756205721255947, 903702557942243359],

You may also need to change the MAIN_BOT_FILE_NAME variable if your main bot's file name is not bot.rb.

Include Jishacum Container to Your Bot

It's really simple, you just need to require jishacum container:

require_relative "jishacum/jishacum"

and, include it to your bot:

bot.include! Jishacum

That's it! Now you have jishacum container included in your bot.

A simple bot example using the jishacum container is in the bot file.

Support or Questions

You can ask questions in this Discord server in the #support channel, or you can send me a DM in Discord: will.#0021.