README.md

king-core

Module's ecosystem and DI (Dependency Injection)

Summary

• System requirements
• Getting started
• Documentation
• Development
• Wiki
• Contribution

System requirements

To run it is necessary that you have the following contents installed:

• JRE 8 or higher.

Getting-started

Download the latest version of plugin on releases and move it to /plugins/ folder. The modules are loaded from /plugins/KCore/modules.

Documentation

You can see the project documentation here

Development

Using github packages:

Maven:

<dependencies>
    <dependency>
      <groupId>io.king.module</groupId>
      <artifactId>core</artifactId>
      <version>VERSION</version>
    </dependency>
</dependencies>

Later use mvn install

Using jitpack:

<repositories>
    <repository>
        <id>jitpack.io</id>
	    <url>https://jitpack.io</url>
	</repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.codeproton</groupId>
        <artifactId>king-core</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

If you're a developer and wants to develop a module to ecosystem, you can see examples on wiki or in the examples bellow.

To start you need to create the configuration from your module

import io.king.core.api.module.ModuleConfig;

public final class ModuleInformation extends ModuleConfig {

    public ModuleInformation() {
        super("ModuleName", "author's name", "A simple example", null);
    }
}

Now you can create your module

import io.king.core.api.cycle.LifeContext;
import io.king.core.api.cycle.LifeCycle;
import io.king.core.api.module.Module;

@Module(config = ModuleInformation.class)
public final class ModuleExample extends LifeCycle {
    
    @Override
    public void init(LifeContext context) {
        context.getLogger().info("Module example has been loaded!");
    }
}

Wiki

do you wanna see more examples? Visit the wiki

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT