ForestCore

API for my plugins

57

ForestCore

ForestCore

A plugin that adds several features at once for my plugins

Key Features

1. Update system

- Automatic update check via Modrinth - Notifications about available updates in the console - Support for all plugins connected to ForestCore

2. Color system

- HEX color support (&#000000) - Vanilla color support (&f) - Convenient `ColorUtils.colorize()` method for use in plugins

3. Plugin management menu

- View all connected plugins - Display information about each plugin: - Name - Version - Plugin ID - Operation status - Ability to edit plugin configuration directly from the menu

4. Command system

- `/fcore` - basic information about ForestCore - `/fcore help` - list of all commands - `/fcore help <plugin-id>` - commands of a specific plugin - `/fcore reload <plugin-id>` - reload plugin configuration - `/fcore menu` - open plugin management menu - `/fcore <plugin-id>` - information about a specific plugin

Installation

For servers

1. Download the latest version of `ForestCore-1.0-SNAPSHOT.jar` from the `target` folder after building the project 2. Place the file in the `plugins` folder of your server 3. Restart the server 4. ForestCore is ready to use!

For developers

Connecting the plugin to ForestCore

1. Adding a dependency

In your plugin's `pom.xml` add:

```xml <repositories> <repository> <id>github</id> <name>GitHub Packages</name> <url>https://maven.pkg.github.com/camper_crafting/ForestCore</url> </repository> </repositories>

<dependencies> <dependency> <groupId>ru.forestcore</groupId> <artifactId>ForestCore</artifactId> <version>1.0-SNAPSHOT</version> <scope>provided</scope> </dependency> </dependencies> ```

2. Adding dependency to plugin.yml

```yaml depend: [ForestCore] ```

3. Registering the plugin

In the `onEnable()` method of your plugin:

```java ForestCore forestCore = (ForestCore) Bukkit.getPluginManager().getPlugin("ForestCore"); if (forestCore != null) { ForestPlugin forestPlugin = new ForestPlugin( "Plugin Name", // plugin name getDescription().getVersion(), // plugin version "plugin-id", // Unique plugin ID "camper_crafting", // author's name "https://modrinth.com/plugin/your-plugin", // link to Modrinth "https://github.com/your-username/your-plugin", // link to GitHub Arrays.asList( // List of plugin commands "/command1 - Command Description 1", "/command2 - Command Description 2" ) ); forestCore.getPluginManager().registerPlugin("plugin-id", forestPlugin); } ```

Use of colors

HEX colors

```java String message = ColorUtils.colorize("&#FF0000Red text"); ```

Vanilla colors

```java String message = ColorUtils.colorize("&cRed text"); ```

Color combination

```java String message = ColorUtils.colorize("&#FF0000Red text &aand green text"); ```

Plugin Example

There is an `example-plugin.yml` in the repository called `ExamplePlugin` that demonstrates: - Connecting to ForestCore - Using colors - Registering commands - Integrating with ForestCore menus

Requirements

- Minecraft 1.16.5 - Paper/Spigot server - Java 8 or higher

Support

If you have any problems or questions, please create an Issue in the GitHub repository.

ADS