Skip to content

The Pylon Master Project

Pylon has a master repository that contains both pylon-core and pylon-base. This allows you to run base using your very own home-baked version of core, which allows you to test new features much more easily. This is what the 'How to get started' section used. We recommend you make changes to both Base and Core using the master repository, and the rest of this guide will assume you're using it.

Project structure

The master project is structured as such: 

1
2
3
4
5
6
7
pylon/
    pylon-base/
    pylon-core/
        dokka-plugin/
        nms/
        pylon-core/
        test/
pylon-base contains the Base addon for Pylon. pylon-core has four subprojects: dokka-plugin, nms, pylon-core, and test. dokka-plugin contains a custom Dokka plugin we use to help with formatting Javadocs. nms contains all the Pylon Core code that touches server internals. It is in a separate subproject to effectively isolate potentially unstable code from the rest of the project. pylon-core contains the main Pylon Core code, and test contains the integration tests for Pylon Core.

Tasks

The Pylon master project contains a few tasks that are useful for development:

Task Alias Description
runServer runSnapshotServer Runs a Minecraft server with the current version of Pylon Base and Pylon Core
:pylon-base:runServer runStableServer Runs a Minecraft server with the latest stable version of Pylon Core and the current version of Pylon Base
:pylon-core:test:runServer runLiveTests Executes the integration tests for Pylon Core

Danger

If you are launching the tasks using the aliases from IntelliJ and attach the debugger, you will notice that it will not work. I have no idea why this happens. In order to successfully attach the debugger, you need to run the actual tasks, not the aliases. For example, instead of running runSnapshotServer, run runServer.