Skip to content
This repository has been archived by the owner on Jul 4, 2022. It is now read-only.
Leonhard edited this page Sep 8, 2020 · 25 revisions

User Guide

SimplixCore is a framework for java development. It includes a set of core Java libraries such as Googles Guava & LightningStorage. It also contains a streamlined Dependency Injection framework using Google Guice, an easy to use localization, configuration, a database framework as well as a set of utilities and a dynamic library loader. It is widely used on most Java & Kotlin projects within SimplixSoftworks.

For Spigot & BungeeCord the SimplixCore works as a plugin. You don't have to shade any parts of the SimplixCore (it's also very discouraged to do so on Spigot/BungeeCord!) By using the SimplixCore as a plugin you can also add extra libraries for the SimplixCore, that can be used for your own plugin as well.

This wiki is a work in progress, and parts of it may still be under construction.

Covers you with everything you need to know on how to get started real quick.

On Spigot/BungeeCord it is advised to load the SimplixCore as a plugin. The QuickStart module is designed to make this process as easy as possible.

Contains every module that is used within SimplixCore.

Covers everything you need to know about the inbuild Dependency-Injection framework using Guice.

SimplixCore provides a clean way of localizing your software using i18n.

A platform-independent ListenerAPI which easily allows you to listen for events and create your own.

SQL framework using HikariCP

Stop blooding your jar file with shaded dependencies. The SimplixPlattform allows to create and load libraries for your .jar file.

Utilities

The SimplixCore was designed with some coding conventions in mind. Here are the basic conventions to follow when contributing to the core.