Developer Guide - xMikux/Slimefun4 GitHub Wiki

Welcome to our Developer Guide! This page is still under construction, as this is a huge topic and will most likely take a long time to complete.

Anyway, let's get started!

Prerequisites

We will try to target a wide range of developers, even ones with less experience. However, we do not want to reinvent the wheel, there are already a lot of extensive tutorials on how to learn Java or how to create bukkit plugins.

We will assume you to be familiar with the basics of Java, Maven, Git and the concepts of Object-orientation. If these words all sound unfamiliar to you, then please read up on these and come back later.

We will do our best to try to explain as much as we can though, but please read these pages thoroughly. You can of course also always questions on our Discord Server in the channel #programming-help. You can click on the discord badge at the bottom of the page to join.

You can also check out our Javadocs to get some more technical information about how the API is structured. But we would advise you to check this guide first.

Table of Contents

  1. Setting up your project
  2. Creating a new addon
  3. Creating your first Item
  4. Adding features to your Item
  5. Adding your own Research
  6. Custom heads
  7. Adding resources to the GEO Miner
  8. Creating electric machines
    • Creating a simple input/output machine with recipes (soon)
    • Creating your own Generator (soon)

?. Publishing your addon