Open NyCodeGHG opened 4 years ago
Both ideas and especially the Docker setup sound great. However, it looks like a lot of work to do. Therefore, I would suggest the following work flow:
What do you think about this process?
I would love to review your first ideas and structure (step 2) according to Docker Minecraft Servers (and Networks) if you have some free time spare. 😇
I think this way with reviews by other contributors would be great.
But I don't fully understand the structure of a guide and in which step i would put my actual content in.
Could you give me a small example?
Sure!
Example: Guide about the Spigot event system
Step 1 (abstract) This guide aims to explain the basics of the Spigot event system including custom events and an overview of all events. The user should be able to listen to different events. [...]
Step 2 (TOC)
2.1 Player events
@EventHandler
annotation
Step 3 (peer-review)
Nice structure. Can you also add a section about custom events by other plugins like Vault? And I think an overview of all events is too heavy. Just name common one like
PlayerMoveEvent
and so.
Step 4 (read comments and adjust) remove section 2 and adding 4.1 External events
Step 5 (guide prototype)
An event is an action that...
and so on
I hope I explained it more understandable. Otherwise, ask me :D
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 :).