Skip to content
Nathan edited this page Nov 21, 2023 · 10 revisions

Setup

Requirements

  • Rich (installed via pip)

Installation

  • Clone this repo into your project folder
  • Rename it to 'command'
  • Inside that folder, create a json file and name it whatever you like (recommended is 'help.json')
  • Copy default.json into your new file
  • Add any function you wish to add following the template

Usage

  • Import the module (1) at the top of your script
  • Add a 'command_dict' dictionary to store all your functions (2)
  • Create your command interpreter by assigning a variable with the CommandReader class (3)
  • To run a command, use the run command, built in to the class (4)

Clone this wiki locally