Welcome to Squishy, a modular Kotlin API designed to simplify the development of Minecraft plugins for both PaperMC and SpongeMC servers. With Squishy, you can access shared tools and abstractions to streamline your development process.
To get started with Squishy, follow these simple steps:
-
Download the Latest Version
- Go to the Releases page to find the latest version of Squishy.
- Look for the latest release, which will have the most recent features and bug fixes.
-
Install Squishy
- Once you are on the Releases page, you will see different files available for download. Choose the file that fits your server type (usually found in the form of a
.jarfile). - Click the download link for that file. Your browser will start the download automatically.
- Once you are on the Releases page, you will see different files available for download. Choose the file that fits your server type (usually found in the form of a
-
Set Up Your Minecraft Server
- Make sure you have either a PaperMC or SpongeMC server running on your machine. Check their official websites for installation instructions if you haven’t set up a server yet.
-
Add Squishy to Your Server
- Locate the
pluginsfolder in your server directory. - Move the downloaded
.jarfile of Squishy into thispluginsfolder. - Restart your Minecraft server to load the new plugin.
- Locate the
-
Configure Squishy
- After starting your server, Squishy may create a folder in the
pluginsdirectory. - Check this folder for configuration files. You can adjust settings based on your requirements for your Minecraft server.
- After starting your server, Squishy may create a folder in the
- Java 8 or higher: Ensure that you have the correct Java version installed as both PaperMC and SpongeMC require Java to run.
- Minecraft server: You need either a PaperMC or SpongeMC server to use Squishy effectively.
- Modular Design: Squishy allows you to choose only the components you need, making your development process more efficient.
- Easy Integration: Works seamlessly with existing PaperMC and SpongeMC projects.
- Shared Tools: Access to common tools and features that simplify the coding process.
- Documentation: Comprehensive guides will help you learn how to make the most of the API.
If you encounter any issues while using Squishy, consider the following:
- Check Your Java Version: Confirm that you are using Java 8 or higher.
- Plugin Conflicts: Sometimes, other plugins may conflict with Squishy. Try disabling other plugins and restart your server.
- Look for Error Messages: If your server crashes, check the console for error messages that can give you clues about the issue.
Squishy will receive regular updates to ensure compatibility and improve features. Remember to check the Releases page often to stay updated.
For help or to report issues, visit the GitHub repository and use the issue tracker. You can also ask questions in forums or communities dedicated to PaperMC and SpongeMC.
To install Squishy, visit the Releases page where you can download the latest version. Follow the installation steps provided above to get up and running quickly.