InsanusMokrassar/PlaguBotBotTemplate
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/PlaguBotBotTemplate.git synced 2024-11-18 05:33:46 +00:00
Code Issues Projects Releases Wiki Activity
Template for simple creating of bot based on PlaguBot (https://insanusmokrassar.github.io/PlaguBot/)
44 Commits 5 Branches 0 Tags 248 KiB
Gradle 100%
6bc9b634a8
Go to file
InsanusMokrassar 6bc9b634a8
Update libs.versions.toml
2022-11-28 18:24:17 +06:00
.github/workflows Update build.yml 2022-01-04 18:50:34 +06:00
gradle Update libs.versions.toml 2022-11-28 18:24:17 +06:00
_config.yml Set theme jekyll-theme-cayman 2020-11-12 13:33:09 +06:00
.gitattributes Initial commit 2020-11-12 13:08:07 +06:00
.gitignore update template 2022-06-17 00:36:25 +06:00
build.gradle update template 2022-06-17 00:36:25 +06:00
config.json update template 2022-06-17 00:36:25 +06:00
gradle.properties update template 2022-06-17 00:36:25 +06:00
gradlew Initial commit 2020-11-12 13:08:07 +06:00
gradlew.bat Initial commit 2020-11-12 13:08:07 +06:00
LICENSE Initial commit 2020-11-12 13:08:07 +06:00
README.md update 2021-02-17 14:57:29 +06:00
settings.gradle fill 2020-11-12 13:28:59 +06:00

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