Skip to content

r3back/the-assistant

Repository files navigation

The Assistant

Libraries aimed to developers with multiple functions that will make you things easier.

Java CI with Gradle

Dependency Usage

Maven

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>
<dependency>
    <groupId>com.github.r3back</groupId>
    <artifactId>the-assistant</artifactId>
    <version>LATEST</version>
</dependency>

Gradle

repositories {
    maven { 
        url 'https://jitpack.io' 
    }
}
dependencies {
    compileOnly 'com.github.r3back:the-assistant:LATEST'
}

Building

The-Assistant uses Gradle to handle dependencies & building.

Requirements

  • Java 17 JDK or newer
  • Git

Compiling from source

$ git clone https://github.com/r3back/the-assistant.git

$ cd the-assistant/

$ ./gradlew build -x shadowJar

You can find the output jars in the plugin/build/libs or build/libs directories.

API Usage

/**
* The Assistant API
  */
  public interface TheAssistantAPI {
  /**
    * Retrieves Command Provider
    *
    * @return CommandProvider of {@link AssistantCommand}
      */
      public CommandProvider<AssistantCommand> getCommandProvider();

  /**
    * Retrieves Dependency Resolver
    * @return {@link DependencyResolver}
      */
      public DependencyResolver getDependencyResolver();

  /**
    * Retrieves Addon Service
    *
    * @return {@link AddonsService}
      */
      public AddonsService getAddons();

  /**
    * Retrieves NMS Multi Version handler
    *
    * @return {@link NMS}
      */
      public NMS getNms();


    /**
     * Retrieves Plugin instance
     *
     * @return {@link Plugin} instance
     */
    public Plugin getPlugin();
}

Integrations

This plugin includes integrations with different plugins:

Economy:

Schematics:

Regions:

Placeholders:

More Integrations:

License

This App is licensed under the GNU license. Please see LICENSE.txt for more info.