paul2708/spigot-plugin-resources

A summary of different resources related to Spigot and Minecraft server software in general.

Spigot Resources

This repository summarises different resources related to Spigot and Minecraft server software in general.

Table of Contents

• API Repository contains a list of several tools, libraries and frameworks.
• External Applications is a list of interesting external applications related to Minecraft.
• Guides are articles, tutorials, and how-tos about programming, development, and concepts in general.
  • Spigot Guides is a selection of already existing guides on SpigotMC.
• Plugins presents open source plugins by their category.
• Requirements is a set of plugin development requirements that should be specified.
• Servers gives an overview of the history of Minecraft server implementations and state-of-the-art software.

Contribution

If you find typos, outdated sources, or new interesting resources, just open an issue! We would appreciate it. ❤️

spigot-plugin-resources's Issues

Add new APIs

Hey there!

You are a Spigot developer and want to participate in the Hacktoberfest?
Great! You can simply contribute by adding at least 2 APIs to the API repository.

Conditions:
Your contribution has to fulfill the following conditions:

• API has to be up-to-date
• insertions must be sorted alphabetically
• if your API doesn't match the given sections, just create a new one

I would love to see your contributions.

Greetings, Paul. ❤️

Where to put external applications?

I found MC-Auth that allows an "easily login with your Minecraft account without giving your password or email to strangers – Fully OAuth 2.0 compliant!"

I'd like to add it to the repository but it's not an API, therefore, api-repository.md seems not to be the right place for it.

Do you have an idea where to put it? Maybe the section could fit other external applications as well.

Guide ideas

This is a small list of my ideas for some guides mentioned in #17.

Development Environment Setup Guide

This guide is for those users, which don't know how to setup a clean environment for a new plugin correctly. Also this might be good for those who just import the Server Jar and build the plugin via Artifacts.

I think either 2 different guides for Gradle and Maven or just one guide with examples for both build systems. (But i think we should recommend Gradle, because it's faster and In my own opinion it's easier to understand and more flexible than maven)

I would give some examples of the build files like either the build.gradle.kts or the pom.xml and explain each step.

Docker Minecraft Servers (and Networks)

I tried myself to setup a minecraft network via Docker, but I found literally no good tutorial or something like that for setting up a network, but I figured it out. I would give some examples to run a minecraft server with this Docker Image by @itzg.
Also I want to show how to use that image with another image for the BungeeCord Proxy Software.
I want to show all examples with a docker run command and a docker-compose file.

Those are my ideas for some guides. More ideas for some guides are welcome :).

New entry: Unknown Spigot features

There are several Spigot features, that were added in the newer versions. However, there isn't a changelog. Therefore, not every change is recognized by developers.
The entry could list these features along with usage and examples.

Possible unknown features:

• Conversation API (Docs)
• PersistentDataHolder API (Forum entry) since 1.14
• Service provider (Docs)
• custom advancements

German translation

Project idea: guides

What do you think about adding a folder like "guides" or something like this and add tutorials or guides for example for setting up a development environment or setting up a server or network correctly etc.

Example:

• 📁 guides
  • 📑 setup-dev-environment.md
  • 📑 setup-a-server.md
  • 📑 setup-server-docker.md
  • 📑 scheduler-guide.md
  • 📑 commands-guide.md
  • 📑 README.md (Index with links to all guides)
• 📑 api-repository.md
• 📑 requirements.md
• 📑 servers.md

Improve requirements

Transfer md files to wiki entries

Add listed projects to their sections

• https://github.com/NyCodeGHG/minecraft-server
• https://github.com/CloudburstMC/Server
• https://github.com/Skungee/Skungee/
• https://www.spigotmc.org/threads/guide-windows-extremely-productive-development-environment.394754/ (still up to date?)
• https://www.spigotmc.org/threads/methods-for-changing-massive-amount-of-blocks-up-to-14m-blocks-s.395868/ (still up to date?)
• https://github.com/ME1312/SubServers-2
• https://github.com/koca2000/NoteBlockAPI
• https://github.com/KibbleLands/KibblePatcher
• https://github.com/LOOHP/InteractiveChat
• https://github.com/Tammo0987/Plugin-Starter
• https://github.com/seeseemelk/MockBukkit
• https://github.com/Incendo/cloud
• https://github.com/PrismarineJS/mineflayer
• https://github.com/Silthus/minecraft-server-template
• https://github.com/MCHPR/MCHPRS
• https://github.com/YatopiaMC/Yatopia
• https://github.com/Akarin-project/Akarin
• https://github.com/pl3xgaming/Purpur
• https://github.com/ProtocolSupport/ProtocolSupport
• https://github.com/ByteZ1337/ParticleLib

New entry: How to write version independent plugins

The api-repository already lists some tools and frameworks that support the development of version-independent plugins.
There could be a new file that explains how to write those plugins.

Possible content:

• usage of listed libraries
• abstraction of version-depended code
• ...

Usefull APIs

Interestin problems

Interesting Repositories

This issue holds a list of interesting repositories and projects related to Spigot and Minecraft, that don't fit any section or category yet.

Fill plugins chapter

At the moment, the plugins chapter is empty.

It should list interesting open-source plugins grouped by their category (e.g., game mode, chat, ...).

Some ideas:

• link to WLOSP
• link to DeinPlugin as open-source plugin provider
• https://github.com/cerus/iota-spigot-poc
• https://github.com/cerus/flatcraft