Modules

How to create a module?

Creating a module is pretty easy, you only need the main class and the module.properties file.

module.properties File

This file will let SimpleCoreAPI know information about your module for other modules to work together, update itself and limit functionality.

main=xyz.theprogramsrc.filesmodule.Main # Main class with package.
name=FilesModule # Name of the module (accepted regex: a-zA-Z0-9)
version=@version@ # The version of the module, it can be text or an injected variable
author=TheProgramSrc # The name of the author to be shown. It can be a team or a username.
description=@description@ # Description, it can be text or an injected variable. This variable is using the custom format with blossom. (Our version of blossom made by FranciscoSolis will work injecting variables to resources.)
module-id=filesmodule # The identifier of this module in the global database (usually the name in lowercase). It's used to load and identify the modules.
dependencies=loggingmodule,networkingmodule # A comma separated list of Module IDs to load before this module (Optional)
github-repository=TheProgramSrc/SimpleCore-FilesModule # The GitHub repository of the module. (Used for the update checker and auto updater). Defaults to `TheProgramSrc/SimpleCore-{name}`, replacing '{name}' with the module name.
disable-standalone=false # If true the module will be disabled when using the Standalone Mode

// Main class example
package xyz.theprogramsrc.filesmodule

import xyz.theprogramsrc.simplecoreapi.global.module.Module

class Main: Module()

The main class only needs to import the class xyz.theprogramsrc.simplecoreapi.global.module.Module and extend it.

Community Modules

These are modules made by the community. If you want yours here join our discord and notify us by creating a ticket or asking in #general.