PetBlocks

branch	status	version	download
master			Download latest release
development			Download snapshots

Description

PetBlocks is a spigot and also a sponge plugin to use blocks and custom heads as pets in Minecraft.

Features

• Use blocks as pets in minecraft
• The GUI and pets are completely customizable
• Version support 1.8.R1 - 1.18.R1
• Check out the PetBlocks-Spigot-Page to get more information.

Installation

• Please check out the PetBlocks Documentation for further information.

Screenshots

Contributing

Setting up development environment

• Install Java 17 or higher
• Fork the PetBlocks project on github and clone it to your local environment.
• PetBlocks requires spigot server implementations from 1.8.8 to 1.18 to be correctly installed in your local Maven cache. As this requires multiple java version to build different versions, a Dockerfile is provided to build these dependencies in a docker container and then copy it to your local Maven cache.

Note: If using Windows, execute the commands using Git Bash.

mkdir -p ~/.m2/repository/org/spigotmc/
docker build --target dependencies-jdk8 -t petblocks-dependencies-jdk8 .
docker create --name petblocks-dependencies-jdk8 petblocks-dependencies-jdk8 bash
docker cp petblocks-dependencies-jdk8:/root/.m2/repository/org/spigotmc ~/.m2/repository/org/
docker rm -f petblocks-dependencies-jdk8
docker build --target dependencies-jdk17 -t petblocks-dependencies-jdk17 .
docker create --name petblocks-dependencies-jdk17 petblocks-dependencies-jdk17 bash
docker cp petblocks-dependencies-jdk17:/root/.m2/repository/org/spigotmc ~/.m2/repository/org/
docker rm -f petblocks-dependencies-jdk17

• Open the project with an IDE, gradle sync for dependencies.

Testing

Option 1

• Setup your own minecraft server
• Change // val destinationDir = File("C:/temp/plugins") to your plugins folder in the petblocks-bukkit-plugin/build.gradle.kts file.
• Run the setupDecompWorkspace task to setup forge dependencies.
• Run the shadowJar task to generate a plugin.jar file.
• Run your minecraft server

Option 2 🐳

• Run the provided docker file.
• The source code is copied to a new docker container and built to a plugin.
• This plugin is installed on a new minecraft server which is accessible on the host machine on the default port on localhost.

docker build -t petblocks .
docker run --name=petblocks -p 25565:25565 -p 5005:5005 petblocks

Licence

Copyright 2015-2021 Shynixn

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.