Skip to content

Releases: FlyingKatsu-Discord-Bots/MrProg

Tech Prototype v0.1.0

21 Jan 23:57
Compare
Choose a tag to compare
Tech Prototype v0.1.0 Pre-release
Pre-release

Known Issues

  • Still contains some legacy code from the initial trash prototype and that really needs to be cleaned up
  • Configurable data is not yet completely separated from actual code (npc and enum are meant to be configurable, but it still contains functions...)
  • Character data is not saved anywhere, so it all disappears when the bot shutsdown (or is disconnected for too long)
  • Dependent on dev to keep bot running on local machine (need a host or a Raspberry Pi for longer uptime)
  • Only works on one server per client instance, based on what is written in the config file
  • Mod commands only work via DM in NormalMode?
  • Temp files never get deleted

Features

  • Config file that lets you decide
    • which server and channels should be used for Normal or Debug modes
    • which roles should have which internal permissions (partnered, mod, or admin)
    • what prefix to use for commands, such as ! or ?>
    • what suffix to use (and enforce) on all partner names
    • what word to use for partners (like NetNavi)
    • what name to give the bot (like Mr. Prog)
  • Other required files that can be modified without touching actual code
    • require/enum for designing personality dialogue, command names and permissions, and character presets/variants
    • require/npc for designing auto responding characters like Mr.Prog and NetOfficial
  • Run multiple versions of the bot in different shells, using different config files
  • Partners have a mood counter that changes each time they respond to the user (make lots of command errors and they slowly get upset with you-- unless you customize the dialogue to act differently)
  • Customize dialogue via JSON text file uploads or file URLs (max size 100KB)
  • Customize avatars via PNG or JPEG file uploads or URLs (max size 100KB)
  • Partner names support non-accented letters, numbers, and Japanese kana or kanji
  • 1 default personality with a few placeholder lines
  • 5 preset categories, 26 character variants
  • 15 unique command functions

Command List

General

  • @Mr.Prog
    • Quick tips. Currently tells you how to create a partner, or to say hi to your existing partner.
  • ?>info preset(s) [optional: preset keyword]
    • Get a list of all available preset-variant pairs, or a summary about a specific character preset.
  • ?>info variant(s) [preset] [variant]
    • Get information about a specific character preset-variant pair
  • ?>help channel ( main | shop | battle | oc | debug )
    • (via DM) Get a list of all commands you are allowed to use in the specified (or current) channel.
  • ?>help command [command]
    • (via DM) Get extended help information about a specific command, such as usage, description, role restrictions, and enabled channels
  • ?>stats
    • (via DM) Get your partner character's battle stats and partition information. Currently shows placeholder values.

Custom Characters

  • ?>create [name] [preset] [variant]
    • Create a new partner character with the given name and optional preset or preset-variant pair.
  • ?>rename [name, alphanumeric, kana, kanji]
    • Rename your partner
  • ?>recolor [hexcolor]
    • Change the color of your partner's embedded messages
  • ?>save ( dialogue | personality )
    • (via DM) Get a text file in JSON format containing your partner's dialogue data. Specify "dialogue" to receive a copy of your custom text, or "personality" to receive a copy of the default text.
  • ?>load avatar [ file | url ]
    • Upload a new image for your partner
    • Changes only show if the server config has enableOC = true (and if specified, only in the OC channel)
  • ?>load dialogue [file attachment | url]
    • Upload custom dialogue file for your character
  • ?>reset
    • Reset all customizations to the default settings (including partner name!!)

Admin / Mod

  • ?>shutdown
    • Turn off the bot completely.
  • ?>test
    • Send a test embed message to the debug channel
  • ?>clear [numMsg, > 2, < 200] ( main | battle | oc | debug )
    • Delete the specified number of messages from the specified (or current) channel. Min of 3 messages, max of 199 messages, default is 10 messages.