Nova

Nova is a powerful gradle plugin that enables you to run any minecraft jar inside your IDE.

Gradle Imports

Add the plugin at the top of your Gradle build file.

build.gradle

plugins {
  id "com.undefinedcreations.nova" version "VERSION"
}

build.gradle.kts

plugins {
  id("com.undefinedcreations.nova") version "VERSION"
}

Setup

Setting up this gradle plugin you will be modifying a task called runServer.

The first thing you will need to set is the minecraftVersion. This will be the server version it will be running.

tasks {
    runServer {
        minecraftVersion("1.21.4")
    }
}

If you are using Echo you won't need to set this anymore. It will check echo for what version of BuildTools it is using and choose that version

Configuration

There are a bunch of configuration that can be done with this plugin.

Server Type

The ServerType is a enum with all the possible jars the task is able to use. They are SPIGOT, PAPERMC, PUFFERFISH, PURPUR, BUNGEECORD, WATERFALL, VELOCITY and FOLIA

If no server type is chosen it will automatically choose Spigot

tasks {
    runServer {
        serverType(ServerType.SPIGOT)
    }
}

Auto accept eula

One of the most annoying part of create test server is accepting the mojang eula. That was why we made an option to automatically accept this.

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        acceptMojangEula()
    }
}

Allowed Ram

You are able to change the amount of ram that the server can use with allowedRam(). This is using the enum called RamAmount

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        allowedRam(4, RamAmount.GIGABYTE) // default : 2 GIGABYTES
    }
}

GUI

Some jars will open a gui on start. This will be disabled by default but you are able to toggle this on again.

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        noGui(false) // default : true
    }
}

Plugins

You are able to autoload plugins into the server at start up

Online

You are able to use spigotmc.org, hangar.papermc.io and modrinth.com links to be able to download plugins automatically onto the server before start. If you want it to re-download every time you can add overwrite

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        plugins(
            "https://www.spigotmc.org/resources/plugin-portal.108700/",
            "https://hangar.papermc.io/Flyte/PluginPortal",
            "https://modrinth.com/plugin/simple-voice-chat"
        )
    }
}

Local

You will also be able to copy local plugins into the server with filePlugin. You can also select if it should overwrite the old one.

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        filePlugins(
            listOf(
                File("C:\\Users\\Undefined\\IdeaProjects\\DifferntProject\\build\\libs\\Custom-plugin.jar")
                ), 
            overwrite = true
        )
    }
}

Server Folder

You can set the folder were the server will run using serverFolder.

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        serverFolder {
            File("$buildFolder/${serverType.name}-$minecraftVersion")
        }
    }
}

You can also use serverFolderName that needs a string inside a file. It will automatically add the folder into build folder then.

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        serverFolderName {
            "$${serverType.name}-$minecraftVersion"
        }
    }
}

Input Task

You are able to select what task it will build with inputTask

If no task is selected it will first check if there is a remap task, if that task was not found it will use shadowJar lastly it will be using jar task

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        inputTask(customTask) 
    }
}

Per version folder

This option will create a new server folder for every minecraft version you will run

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        perVersionFolder(true) // default : false
    }
}

Custom Jars

Using this plugin you are also able to use custom jars. To use them you need to give the path to the jar.

WARNING

Note: Using custom jars might break the plugins downloader and the mcVersion will have 0 effect on the minecraft version the server is running.

tasks {
    runServer {
        minecraftVersion("1.21.4")
        
        customJar("C:\Users\UndefinedAdmin\Documents\CoolJar.jar", alwaysReplace = true)
    }
}

The alwaysReplace option will be replacing the jar every time you start the server.