Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 3.99 KB

installation.md

File metadata and controls

51 lines (33 loc) · 3.99 KB
Raw
description
Learn how to quickly and easily install Gizmo with this step-by-step guide.

🛠️ Installation

Installing Minecraft plugins can be a tricky start, especially with a plugin with such a large codebase and lots of configurations like Gizmo. We'll walk through creating a Java Minecraft server that supports Gizmo, adding Gizmo, and ensuring the plugin works as expected.

Technical Requirements

Gizmo is a very lightweight plugin and doesn't use many resources server-wise, this means that it's light on memory, CPU usage, and IO.

Recommended Server Requirements

As per the paper documentation, the server requirements are the following:

  • Java Version: Java 21 (for Minecraft 1.20.x)
  • RAM/Memory: 4GB-6GB Minimum
  • CPU: Intel i5, Intel i7, Xeon, or greater depending on the plugins the server is hosting
  • Storage Space: 24GB or greater
  • OS: Windows or a suitable Linux Distribution that can both install Java and run the official PaperMC server software or a PaperMC fork that contains the Kyori Adventure Library
  • Network: 50MB/s or greater for download and 10MB/s or greater for upload

Plugin Requirements

In order for Gizmo to fully function properly, you will need to install PlaceholderAPI.

Creating a PaperMC Server

Although this is an important step in the process of hosting and utilizing the plugin, we will not be outlining the steps of creating and running a PaperMC server to use the plugin. We would like to kindly refer you to the PaperMC getting started guide for detailed steps on installing the required dependencies of PaperMC and for details on downloading, installing, and running the PaperMC server.

Installing Gizmo

Now that you have created a PaperMC server, accepted the Minecraft EULA, and generated the files for your newly or currently existing server, you can now move on to installing the plugin and can get it up and running. Below you can find the steps detailed and laid out one by one:

  1. If your server is currently running, please stop your server and ensure that it gracefully shuts down and saves all vital data from the previously run session.
  2. Download Gizmo by visiting the official plugin page. Save the plugin in an easy-to-remember location that you can easily access in the next few moments.
  3. Open up the root directory of your server location, this is where your server JAR is currently located. Navigate to the plugins directory and place the Gizmo plugin JAR that you downloaded in that directory.
  4. Navigate back to the root of your server and start the PaperMC server via the script file you have created locally OR start your server the way you usually start your server. Whether it be a hosting panel or a command you tend to use regularly.
  5. View your console or your current server logs, if no errors have appeared in your console in regards to Gizmo and a successful Bloons startup message has appeared then congrats, the plugin has now loaded Gizmo! If there is an error or a warning of any importance in your console, please address it and reach out for support on our Discord server.
  6. Ensure that all default files generated properly by navigating to /plugins/Gizmo and reviewing the language/locale files and various configurations by confirming that they are present and have the proper contents.

Congratulations on loading the Gizmo plugin up and setting up your server if you haven't already done so! Our goal with Gizmo was to make it as easy and seamless as possible to upload it to your server to ensure the best possible user experience as possible when utilizing your PaperMC server.

From all of Jeqo Studios, we hope you enjoy Gizmo.

{% hint style="info" %} Troubleshooting & Support

Having issues with Gizmo? Join our community Discord server and leave a message! {% endhint %}