MapRender Plugin Documentation
Version: 1.0
Author: FuntasiaNetwork
Introduction
MapRender is a Minecraft plugin that allows players to render PNG images directly into the Minecraft world using blocks. It converts every pixel of your image into a corresponding Minecraft block, making it perfect for building pixel art, custom logos, and detailed
building schematics. The plugin gives you control over the
design layout and scaling of the image.
Installation
Follow these steps to install MapRender on your Minecraft server:
- Download the latest version of the MapRender plugin .jar file.
- Place the .jar file into the plugins/ folder of your Minecraft server directory.
- Start or restart your server to load the plugin.
- A new folder called plugins/MapRender/render_images will be automatically created. This is where you will upload your PNG files.
Configuration
No configuration file is required for basic usage of the plugin. However, the render_images folder will be automatically created in the plugins/MapRender directory, where you can store the PNG files you want to render in-game.
Usage
MapRender is easy to use. Here’s how you can start rendering images and managing your world art.
Steps to Render an Image:
- Upload a PNG:
- Place your PNG image in the plugins/MapRender/render_images/ folder on your server.
- Render the Image in the World:
- Use the /maprender command to render your image in the Minecraft world. You can specify the file name of the PNG and adjust the scale if necessary.
- Remove a Rendered Image:
- Use the /mapremove command to remove the last rendered image by the player.
Commands
/maprender <filename> <scale>
- Description: Renders a PNG image from the render_images folder in your Minecraft world. You can specify the scale at which the image should be rendered.
- Example: /maprender logo 1.5
- This will render the image logo.png at a smaller size than the original.
- Arguments:
- filename: The name of the PNG file (without the .png extension) located in the render_images folder.
- scale: The scale factor to resize the image. Larger numbers make the image smaller, and smaller numbers make the image bigger. For example, 1.0 is the original size, 0.5 doubles the size, and 2.0 halves the size.
/mapremove
- Description: Removes the last image rendered by the player from the Minecraft world.
- Example: /mapremove
Examples
Example 1: Rendering a Small Logo
If you have an image called logo.png in the render_images folder, you can render it with:
/maprender logo 1.0
This will render the image at its original size in the Minecraft world.
Example 2: Scaling an Image
If you want to render an image larger or smaller, adjust the scale parameter:
/maprender logo 2.0
This will double the size of the image when it is rendered.
Example 3: Removing a Rendered Image
To remove the last rendered image:
/mapremove
This will remove the last image rendered by the player who issues the command.
Troubleshooting
Common Issues
- Image Not Found:
- Ensure the PNG file is correctly placed in the plugins/MapRender/render_images folder.
- Ensure the file name in the command matches exactly (case-sensitive).
- Invalid Scale Factor:
- The scale factor must be a positive number. Larger numbers make the image smaller, and smaller numbers make it bigger.
- Block Rendering Delays:
- Large images may take a while to render. Increase the server's processing power if rendering large, detailed images.
Frequently Asked Questions (FAQ)
Q: Can I render images in multiplayer?
A: Yes, multiple players can render images simultaneously in multiplayer mode. The plugin manages each player’s render data independently.
Q: What types of images are supported?
A: Only PNG files are supported. Ensure your images are in the correct format before uploading.
Q: Can I render animated images?
A: No, currently only static PNG images are supported. Animated formats like GIFs are not supported.
Q: What happens if I render a very large image?
A: Larger images will take longer to render and may cause some performance drops depending on server resources. It’s recommended to start with smaller images and increase the scale gradually.
Q: Can I remove only part of a rendered image?
A: No, the /mapremove command removes the entire last-rendered image. For partial removal, you'll need to manually clear the blocks.
Support
For additional support or to report bugs, please visit the plugin's support page on Spigot, or contact the developer directly via the provided contact details.
Enjoy using MapRender!