HeavenLibrary

HeavenLibrary is a Minecraft Java server plugin library that aims to make it simple to extend into any Minecraft Java server platform.

Pre-release Artifacts

You can quickly download an artifact from a commit if you don't know how to compile the source code. Check it out here!

JavaDocs

Java Documentation can be found here.

Contributing

I'm always looking for others to add more features or implementations to other Minecraft Java server platforms. Pull requests and forks are welcome!

Maven

Add this your pom.xml file and it should import to your project.

<repository>
    <id>heavenreborn</id>
    <url>https://maven.heavenreborn.com/snapshots</url>
</repository>

<dependency>
    <groupId>com.github.rfsmassacre</groupId>
    <artifactId>HeavenLibrary</artifactId>
    <version>1.0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Usage

Everything is aimed to be as easy to extend for any platform. Right now the only platforms available are Paper and Velocity. I dropped support for Bungeecord and Waterfall since they are deprecated.

Make sure to use the proper class for your platform.

File Data

• Paper

PaperConfiguration config = new PaperConfiguration(this, "", "config.yml");
PaperLocale locale = new PaperLocale(this, "", "locale.yml");

• Velocity

VelocityConfiguration config = new VelocityConfiguration(this, "", "config.yml");
VelocityLocale locale = new PaperLocale(this, "", "locale.yml");

All the configuration files need to be provided in the resources folder in your plugin's jar. If it does not exist, it will give an error on startup.

Simple Commands

If you intend to use a no-argument command, feel free to use a SimpleCommand for your platform.

• Paper

public class ExampleSimpleCommand extends SimplePaperCommand
{
    public ExampleSimpleCommand()
    {
        super(ExamplePlugin.getInstance(), "example");
    }

    @Override
    public boolean onRun(@NotNull CommandSender sender, @NotNull String... args)
    {
        //Do something.
    }

    /**
     * This is optional to implement. If you want auto-complete, use this 
     * 
     * @param sender Sender.
     * @param command Command.
     * @param label Label.
     * @param args Arguments.
     * @return List of suggestions.
     */
    @Override
    public @Nullable List<String> onTabComplete(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String... args)
    {
        //Make sure to actually give the auto-completed arguments you need.
        return Collections.emptyList();
    }
}

• Velocity

public class ExampleSimpleCommand extends SimpleVelocityCommand
{
    public ExampleSimpleCommand()
    {
        super(ExamplePlugin.getInstance(), "example");
    }

    @Override
    public boolean onRun(@NotNull CommandSource sender, @NotNull String... args)
    {
        //Do something.
    }

    /**
     * This is optional to implement. If you want auto-complete, use this 
     *
     * @param sender Sender.
     * @param args Arguments.
     * @return List of suggestions.
     */
    @Override
    public @Nullable List<String> onTabComplete(@NotNull CommandSource sender, @NotNull String... args)
    {
        //Make sure to actually give the auto-completed arguments you need.
        return Collections.emptyList();
    }
}

This expects you to make your plugin class's instance for the platform you need it for, but you can easily just have it pass the instance as a parameter.

Complex Commands

If you need each argument to do a LOT of code, then extend from the Command of your platform. It extends SimpleCommand and implements some things already for you.

It handles permissions already for you and will already execute the first SubCommand when no argument is given. This also autoload all the SubCommand classes within the Command classes in the order it's written, meaning the first SubCommand class inside in the class will be the first SubCommand found.

• Paper

public class ExampleCommand extends PaperCommand
{
    public ExampleCommand()
    {
        super(ExamplePlugin.getInstance(), "example");
    }
    
    private class ExampleSubCommand extends PaperSubCommand
    {
        public ExampleSubCommand()
        {
            super("command");
        }
        
        @Override
        protected void onRun(CommandSender sender, String... args)
        {
            //Do something.
        }

        /**
         * This is optional to implement. If you want auto-complete, use this 
         *
         * @param sender Sender.
         * @param args Arguments.
         * @return List of suggestions.
         */
        @Override
        public List<String> onTabComplete(CommandSender sender, String... args)
        {
            return Collections.emptyList();
        }
    }
}

• Velocity

public class ExampleCommand extends VelocityCommand
{
    public ExampleCommand()
    {
        super(ExamplePlugin.getInstance(), "example");
    }
    
    private class ExampleSubCommand extends VelocitySubCommand
    {
        public ExampleSubCommand()
        {
            super("command");
        }

        @Override
        protected void onRun(CommandSource sender, String... args)
        {
            //Do something.
        }

        /**
         * This is optional to implement. If you want auto-complete, use this 
         *
         * @param sender Sender.
         * @param args Arguments.
         * @return List of suggestions.
         */
        @Override
        public List<String> onTabComplete(CommandSource sender, String... args)
        {
            //Make sure to actually give the auto-completed arguments you need.
            return Collections.emptyList();
        }
    }
}