Go to file
2022-06-18 19:51:31 +06:00
.github/workflows Initial commit 2022-06-17 21:54:20 +06:00
gradle introduction plugin 2022-06-17 22:24:44 +06:00
introduction add docs in introduction plugin 2022-06-18 19:51:31 +06:00
_config.yml Initial commit 2022-06-17 21:54:20 +06:00
.gitattributes Initial commit 2022-06-17 21:54:20 +06:00
.gitignore Initial commit 2022-06-17 21:54:20 +06:00
build.gradle introduction plugin 2022-06-17 22:24:44 +06:00
config.json introduction plugin 2022-06-17 22:24:44 +06:00
gradle.properties Initial commit 2022-06-17 21:54:20 +06:00
gradlew Initial commit 2022-06-17 21:54:20 +06:00
gradlew.bat Initial commit 2022-06-17 21:54:20 +06:00
LICENSE Initial commit 2022-06-17 21:54:20 +06:00
README.md Initial commit 2022-06-17 21:54:20 +06:00
settings.gradle update name of project 2022-06-18 19:19:04 +06:00

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