Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

justinhschaaf/YamlToBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

YamlToBot

Github All Releases GitHub release GitHub last commit Wiki GitHub License

Create a bot from the given YAML file.

Deprecation/Archival Notice

As of February 1, 2024, YamlToBot and all associated repositories will be archived, and the website will be defunct. The project has outlived it's usefulness for me and hasn't been updated in so long to the point where it likely does not work anymore--and even if it does, you shouldn't use it. If you're interested in taking ownership and continuing the project, please reach out to me via email so we can work something out.

If you're still interested in what I've been up to all these years, my website links to various projects and socials you may find interesting. Thank you for your support.

Donate

If you like what I do, then please consider supporting me on Liberapay.

Donate

First-time Usage

When beginning with YamlToBot, simply run the Jar file and it should automatically generate a default configuration file that looks something like this:

activity: "YamlToBot"
commands: 
  - 
    description: "Play Ping Pong!"
    enabled: "true"
    message: 
      - "pong!"
    name: "ping"
  - 
    builtin: "true"
    description: "Shows a list of commands."
    enabled: "true"
    message: 
      - "Commands:"
      - "%cmd% | %desc%"
    name: "help"
    script: "HelpCommand"
    usage: "::help <command name>"
name: "MyFirstBot"
prefix: "::"
token: 123456789012345678

To get started, all you have to do is fill out the "token" option in the config with your bot's token. If your using Discord, then this will be your bot's Client Secret. If you are using Twitch, this will be your bot's application OAuth token. For a more in-depth tutorial for getting started, visit the wiki.

APIs Used

Name Author Usage
eo-yaml decorators-squad Parsing the YAML configuration file
Javacord Javacord Connecting to and interacting with Discord
Twitch4J PhilippHeuer Connecting to and interacting with Twitch
beam-client-java Mixer Connecting to and interacting with Mixer
YAOSJA Justin Schaaf FileManager.moveFile(source, dest) for logs.
JSON-P JavaEE Parsing JSON in the version checker.
PgsLookAndFeel Patrick Gotthardt Look and Feel