Added README and LICENSE

- Created README.md - Created LICENSE
2021-01-20 19:00:35 +01:00
1 parent afff597c10
commit c7ae1da1b1
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present José M. Moreno <josemmo@pm.me> (https://github.com/josemmo)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
@@ -0,0 +1,50 @@
+# Yet Another Minecraft Image Placing Addon
+[![Latest Version](https://img.shields.io/github/v/release/josemmo/yamipa)](https://github.com/josemmo/yamipa/releases/latest)
+![Minecraft Version](https://img.shields.io/badge/minecraft-1.16-blueviolet)
+[![License](https://img.shields.io/github/license/josemmo/yamipa)](LICENSE)
+
+Yamipa is an Spigot plugin that allows you to place images on any surface in your Minecraft server.
+It is designed with performance and compatibility in mind, so even the most low-specs servers should be able to run it.
+
+## Requirements
+- Minecraft 1.16 (tested on 1.16.4)
+- [CommandAPI](https://commandapi.jorel.dev/)
+- [NBTAPI](https://www.spigotmc.org/resources/nbt-api.7939/)
+- [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/)
+
+## Installation
+Download the JAR file for the [latest release](https://github.com/josemmo/yamipa/releases/latest) and copy it to the
+"plugins" directory of your Bukkit/Spigot/Paper server. That's it!
+
+## Configuration
+Yamipa is ready to go out of the box. By default, it creates the following files and directories under the
+`plugins/YamipaPlugin` directory:
+
+- `cache`: A directory containing cached images to speed up the rendering process. You shouldn't modify its contents.
+- `images`: **This is the directory where you put the image files** you want to place in your Minecraft world.
+- `images.dat`: A file holding the list and properties (e.g. coordinates) of all placed images in your server. You
+shouldn't modify its contents.
+
+You can change the default path of these files by creating a `config.yml` file in the plugin configuration directory:
+```yaml
+verbose: false         # Set to "true" to enable more verbose logging
+images-path: images    # Path to images directory
+cache-path: cache      # Path to cache directory
+data-path: images.dat  # Path to placed images database file
+```
+
+## Usage
+This plugin adds the following commands:
+
+- `/image list`: List all available files in the images directory.
+- `/image download <url> <filename>`: Download an image from a URL and place it in the images directory.
+- `/image place <filename> <width> [<height>]`: Place an image of size `width`x`height` blocks.
+- `/image remove`: Remove a placed image from the world without deleting the image file.
+
+### Permissions
+By default, only server OPs have all plugin permissions granted:
+
+- `yamipa.list`
+- `yamipa.download`
+- `yamipa.place`
+- `yamipa.remove`