Simple Spout plugin example

Introduction

This is a template for a Spout plugin.

It compiles, and adds some example content:

• There is an item example_stuff:example_green_screen_paint that is crafted from 1 green dye
• There is a block example_stuff:example_green_screen_block that is crafted from any wool and the green screen paint
• When a player looks at a green screen block, they receive a chat message telling them so.

If you want a blank template that contains no content, see here.

To make this template into your own plugin, you should:

• Make a new project by clicking Use this template on the top-right
• Replace the plugin name in settings.gradle.kts
• Replace the group and description in gradle.properties
• Replace the plugin name and website in src/main/resource/paper-plugin.yml
• Rename the com.example.spoutexampleplugin package
• Rename the ExamplePlugin and ExamplePluginBootstrap classes
  (and update paper-plugin.yml)
• Replace the plugin name in src/main/resource/data_pack/pack.mcmeta
• Replace the existing content in src/main/resources/data_pack and src/main/resources/resource_pack
  with your own content (and update the namespaces in paper-plugin.yml)
  (you can read how to add your own blocks and items on the wiki)
• Replace the existing code in ExamplePluginListener with your own code
• Replace the text in this README.md
  (you may keep the download/installation instructions below, or modify them as you like)

How to test

• ./gradlew jar to build the plugin JAR
• ./gradlew downloadServer to download the Spout server JAR (needed for below)
• ./gradlew runServer to spin up a Spout server with the plugin

Download

Download the latest release from the Releases on the right, or a development version from Actions on the top (click a version, and scroll down to Artifacts).

Installation

Place the .jar file into the plugins folder.

Requires Spout.