https://github.com/imfi-jz/CustomBlueprints

Source code of a Minecraft plugin written in Haxe. The plugin allows players to create blueprints of built structures.
https://github.com/imfi-jz/CustomBlueprints

bukkit haxe minecraft minecraft-plugin plugin spigot spigot-plugin

Last synced: 23 days ago
JSON representation

Source code of a Minecraft plugin written in Haxe. The plugin allows players to create blueprints of built structures.

• Host: GitHub
• URL: https://github.com/imfi-jz/CustomBlueprints
• Owner: imfi-jz
• License: lgpl-2.1
• Created: 2022-10-19T13:31:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-30T09:52:07.000Z (over 1 year ago)
• Last Synced: 2023-04-30T10:38:19.342Z (over 1 year ago)
• Topics: bukkit, haxe, minecraft, minecraft-plugin, plugin, spigot, spigot-plugin
• Language: Haxe
• Homepage: https://www.spigotmc.org/resources/custom-blueprints.105864/
• Size: 154 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        


# Custom Blueprints

Custom Blueprints is a Minecraft plugin that can run on Spigot servers. The plugin is written in the [Haxe programming language](https://haxe.org/), using the **[Haxe Minecraft API](https://github.com/imfi-jz/hx-mc-api)**. The plugin can be downloaded [from SpigotMC](https://www.spigotmc.org/resources/custom-blueprints.105864/), along with the [Haxe Minecraft plugin loader](https://www.spigotmc.org/resources/haxe-plugin-loader.103369/), which is **required** for this plugin to work on a Spigot server.

## Showcase

The following video showcases [the plugin's features in-game](https://youtu.be/O6vdADBGdGM):

[](https://youtu.be/O6vdADBGdGM)

# Purpose

This GitHub hosts the source code of the plugin for learning purposes. The project is by no means neatly structured, but it is fairly small and shows you how to do various things with the API. 

It uses the **event system** (PlayerInteractEvent), creates and reads a **YML** config file, modifies **inventories** and **blocks** in the world, stores **persistant data** inside items and works with the **coordinate system** extensively. Furthermore the plugin uses the API's **debugger** and it uses the shared memory system to allow other plugins to cancel blueprints based on player or coordinates (see [code examples](https://github.com/imfi-jz/CustomBlueprints/releases/tag/d0.5)). Lastly the project shows what **compilation flags** can be used in a Haxe Minecraft plugin (see `build.hxml`).

Feel free to browse the source code, ask questions and copy it if you like.

# Contributions

This repository was not created with the intention to receive contribution but suggestions are always welcome.

## Contact

Join my Discord server to chat, ask questions or make suggestions.

[](https://discord.gg/2KedGjpQMR)

## Support

This project is free to use as stated by the license. If you would like to support this project you can [donate to the developer](https://www.paypal.com/donate/?hosted_button_id=TZRUV2B66PZKQ).

[![QR code to donate](https://panels.twitch.tv/panel-28008197-image-30c20ce1-8c4c-455a-9f74-950cdf9ead76)](https://www.paypal.com/donate/?hosted_button_id=TZRUV2B66PZKQ)

# License

GNU Lesser General Public License (LGPL) (see LICENSE.txt).