mirror of https://github.com/Sheldan/abstracto.git synced 2026-01-01 15:28:35 +00:00

Go to file

Sheldan 448332f24f [AB-318] adding a mention of the original message to link embed

updating JDA version

2021-09-04 16:30:16 +02:00

.github/workflows

[AB-246] fixing new lines being removed from parameters

2021-05-02 20:33:23 +02:00

abstracto-application

[AB-318] adding a mention of the original message to link embed

2021-09-04 16:30:16 +02:00

bundled-licenses

[AB-xxx] adding support for automatic setup steps

2021-06-27 00:20:15 +02:00

.gitignore

added assignable role place module including: setting up, configuring, deleting commands and documentation

2020-08-12 20:01:15 +02:00

LICENSE

added first version of readme

2020-06-10 18:01:33 +02:00

README.md

[AB-318] adding a mention of the original message to link embed

2021-09-04 16:30:16 +02:00

README.md

Abstracto

Abstracto represents a framework to be used as a basis for a Discord bot. It uses JDA as an API wrapper underneath and provides an extensive tool set to create new commands and a wide range of commands out of the box.

This repository does not provide the full functionality in order to start a discord bot, because it requires a Main class. An example implementation of this bot can be seen here. This repository contains the required configuration in order to run a bot and example customizations.

Technologies

JDA The Discord API Wrapper in the version 4.3.0_315
Spring boot is used as a framework to create standalone application in Java with Java EE methods. (including Dependency injection and more)
Hibernate is used as a reference implementation of JPA.
Freemarker is used as a templating engine. This is used to provide internationalization for user facing text and enable dynamic embed configuration.
Ehcache is used as a caching implementation.
Lombok is used as a framework in order to speed up creation of container classes and builders.
Quartz is used as a scheduling framework in order to provide functionalities which either require a delayed or cronjob behaviour.
Docker is used to package the application into a container and Docker Compose is used to connect the required containers together.
Liquibase is used to manage changes to the database

Documentation

A detailed documentation of the pure form of Abstracto including the terminology and commands in HTML form is available here. The PDF is available here If you want to view the documentation to an earlier released version you need to append the desired version to the URL. The current version will be available aforementioned URL, but it is not right now, because Abstracto has not been released yet.

Customization documentation

TBD when Abstracto is released, as the current version is still being adapted, because of findings from the example customization in Crimson.

Issues

If you find any issue, feel free to create a GitHub issue.

License

This project is licensed under the MIT license.