Template for simple creating of bot based on PlaguBot (https://insanusmokrassar.github.io/PlaguBot/)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
InsanusMokrassar cccbad957e
Update gradle-wrapper.properties
3 weeks ago
.github/workflows Update build.yml 1 year ago
gradle Update gradle-wrapper.properties 3 weeks ago
.gitattributes Initial commit 2 years ago
.gitignore update template 8 months ago
LICENSE Initial commit 2 years ago
README.md update 2 years ago
_config.yml Set theme jekyll-theme-cayman 2 years ago
build.gradle Update build.gradle 2 months ago
config.json update template 8 months ago
gradle.properties update template 8 months ago
gradlew Initial commit 2 years ago
gradlew.bat Initial commit 2 years ago
settings.gradle fill 2 years ago

README.md

PlaguBot Bot Template

  1. Update your dependencies here. Usually in gradle projects/readmes developers define names of their dependencies
  2. Edit config. The main points (full list of parameters with explanation:
    • Change database section
    • Change bot token
    • Change list of plugins:
      • Field type - it is name of the plugin provided by developer/dependency
      • Other fields are parameters of plugin and must be provided directly
      • Example is available in the example section: here Hello is name of plugin and parameter is its configuration parameter
    • Change params:
      • Any key here will be available in plugins as name of param
      • Any value must contains:
        • type to detect which one object to instantiate
        • Other type parameters
      • You may look into example related to database in config: defaultDatabase is easily available in plugins as params.database extension

How to launch

There are two main ways to launch it:

  • Run ./gradlew build && ./gradlew run --args="PATH_TO_YOUR_CONFIG" with replacing of PATH_TO_YOUR_CONFIG
  • Run ./gradlew build and get zip of bot and unarchive it somewhere you need. In this archive there is an executable files bot.bat (for windows) and bot (for linux) by the path inside of archive /bot/bin. After unarchiving you can just launch executable file with one argument: path to the config