Skip to content

marcocusano/minecraft-roleplay

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Minecraft Roleplay Development Status

  • Phase 1 - Web Engine: REST API System based on Laravel;
  • Phase 2 (Current) - Layout: All web application pages, based on Laravel seeding;
  • Phase 3 - GodMode: A working web application with god powers! (Actions can be executed without login or permissions filter);
  • Phase 4 - Web Release: The first working release of the web application;
  • Phase 5 - Goto Minecraft: An alpha version of the Minecraft plugin;

YOU MAY CLONE THIS REPO WHEN THIS MESSAGE WILL BE REMOVED AND WHEN YOU SEE A VERSION ON TOP OF ME!


Minecraft Roleplay Management System

Minecraft Roleplay

The definitive guide to host and code your own Minecraft Roleplay Server! Follow this guide to start a new pre-configured Minecraft Server and Web Application. This Repo was made to self-host a working end-user project. If you find a bug from an existing feature you're free to open a pull request.

Do not ask for support if you edit the code of your own, breaking everything cuz you're a PiZzA ChatGPTer. That's a free project and you're free to use as free to leave! Don't you think so?

Requirements

  • JDK (17+)
  • MySQL (5.7+)
  • NPM (9.7+)
  • Node.js (18.14+)
  • PHP (8.2+)

Server Setup

The following guides include a Web Server installation and a Minecraft Server pre-configuration:

  • Localhost (Windows + Docker + Paper)
    You can even check the localhost branch to get your pre-configured Docker and Paper localhost.
  • VPS or a Dedicated Server (Ubuntu + Paper + (optional) Velocity)
    You can even check the ubuntu branch to get your pre-configured Ubuntu Server, then run install-single.sh for a single-server configuration (Paper Only) or install-multi.sh to use (Velocity + Paper Lobby + Paper Roleplay)

Technical Details

FAQ

Which server should I buy?

Of course, it depends on your Project budget and aspectative. How many players are you looking to have? Are you looking for a self-hosted solution (like a VPS or a Dedicated) or a pre-made solution? I'm not going to talk about pre-made solutions but self-hosted solutions. So, if you've a little budget you actually need a Single-Server Configuration. Instead, if you've an higher budget you can try the Multi-Server Configuration.

Which Minecraft Server engine should I use?

Absolutely PaperMC fork of Spigot, fork of Bukkit. Implements both in a balanced and optmized performance. Instead, If you're looking for a multi-server engine (with a Lobby, for example), you may use Paper for your Lobby, Vannilla, etc. and Velocity as a Proxy mandatory. Also, if you are a Developer you should try to taking a look to a very-well-documented APIs. Those links may not be updated, but you can even try to use Google!

Which Minecraft plugins should I install?

There is an infinite-archive of plugins on SpigotMC. Here is a list of core plugins and more suggested for a good quickstart of your Roleplay Server.

How can i customize my Minecraft Server?

ItemsAdder, ModelEngine + MythicMobs and more and more and more... If you didn't see yet, here is a list of core plugins and more to customize your server. Also, you can create custom resource-packs importing Custom Models made with Blockbench! Here is a list of pre-made Roleplay models!

Can I use Skript to create custom features?

The quick answer is NO. First of all it's not a programming language and then offers a bad-performance on high volume of Players using complexed Skripts. But I'm not here to judge: you can even try to use it by yourself. Here is a good website to start. Also, you can join the Discord Community that will help you a lot. If you're a Developer and not a ChatGPTer, you can try to learn Java directly. Or maybe yes, try to ask ChatGPT how to...

License in few words

Completely described here (GNU AGPL 3.0). The features available within this project, web app, Minecraft plugin, and others may differ from what is offered by platforms that adopt part or all of the logic present here. Feel free to use, re-use this project as you wish, also for commercial purposes, but including a credit of the original author, for remote usage too. If not, you're not allowed to use it.

About

Here we're with a free Laravel + Vue.js Minecraft Roleplay Management System and pre-configured Java Minecraft Server with free custom models and plugins.

Resources

License

Stars

Watchers

Forks

Releases

No releases published