Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aleksandarharalanov/reciplus

Custom crafting and smelting recipes.
https://github.com/aleksandarharalanov/reciplus

bukkit craftbukkit craftbukkit-1060 craftbukkit-1092 minecraft minecraft-beta minecraft-plugin project-poseidon uberbukkit

Last synced: about 1 month ago
JSON representation

Custom crafting and smelting recipes.

Awesome Lists containing this project

README

        

# ReciPlus
## What's ReciPlus?
**ReciPlus** is a Minecraft plugin designed for servers running version b1.7.3. It allows server operators to add custom crafting and furnace recipes with high customizability.

---
### Download
Latest releases of **ReciPlus** can be found here on [GitHub](https://github.com/AleksandarHaralanov/ReciPlus/releases).

Alternatively, you can also download through [Modrinth](https://modrinth.com/plugin/ReciPlus/versions).

The plugin is fully open-source and transparent.

If you'd like additional peace of mind, you're welcome to scan the `.jar` file using [VirusTotal](https://www.virustotal.com/gui/home/upload).

---
### Requirements
Your b1.7.3 server must be running one of the following APIs: CB1060-CB1092, [Project Poseidon](https://github.com/retromcorg/Project-Poseidon) or [UberBukkit](https://github.com/Moresteck/Project-Poseidon-Uberbukkit).

---
### Usage
By default, only OPs have permission.

Use PermissionsEx or similar plugins to grant groups the permission, enabling the commands.

#### Commands
- `/rp` - View ReciPlus commands.
- `/rp about` - About ReciPlus.
- `/rp reload` - `reciplus.config` - Reload ReciPlus configuration.

#### Permissions:
##### Single permissions:
- `reciplus.config` - Allows player to reload the ReciPlus configuration.
##### Wildcard permissions:
- `reciplus.*` - Wildcard permission granting everything. (Currently only `reciplus.config`)

---
### Configuration
Generates configuration files `shaped.yml`, `shapeless.yml`, and `furnace.yml` located at `ReciPlus/recipes`.

> [!CAUTION]
> It is **very** important to follow these layout patterns exactly as they are.
>
> Otherwise, the plugin will not work, or you might even end up with improper recipes.

#### Setting up custom recipes
```yaml
shaped:
r1: # rX - X being the number of the recipe. Always start from 1 and increment by 1 accordingly
result:
id: "X" # ID of the result item
amount: X # Amount of the result item (1-64)
grid: # 3x3 Grid (* for nothing - Character to assign to an ingredient)
- "***"
- "***"
- "***"
ingredients:
- "X;X" # Left is assigned character for ingredient - Right is ID of that ingredient
- ... # Optional: Multiple ingredients
rX:
...
```
```yaml
shapeless:
r1: # rX - X being the number of the recipe. Always start from 1 and increment by 1 accordingly
result:
id: "X" # ID of the result item
amount: X # Amount of the result item (1-64)
ingredients: ["X", ...] # ID of ingredient(s) - You must have a minimum of 1 and a maximum of up to 9; duplicates are allowed
rX:
...
```
```yaml
furnace:
r1: # rX - X being the number of the recipe. Always start from 1 and increment by 1 accordingly
result:
id: "X" # ID of the result item
amount: X # Amount of the result item (1-64)
source: "X" # ID of the source item
rX:
...
```
> [!TIP]
> When writing IDs, you can include metadata if desired, as long as the item can support metadata.
>
> For example, `"35:14"` represents Red Wool, whereas `"35"`, or `"35:0"`, represents White Wool.
>
> Click [here](assets/Items.png) for a list of all Minecraft b1.7.3 IDs.

#### Disabling custom recipe types
If you do not wish to use a certain type of recipe in this plugin, navigate to `ReciPlus/recipes/recipe.yml`, clear the configuration, and put the following inside:
```yaml
shaped: []
```
```yaml
shapeless: []
```
```yaml
furnace: []
```
> [!NOTE]
> Do **not** delete the configuration files. Instead, use the aforementioned method to disable them.