|
1 | 1 | # BlacklistedItems |
2 | | -Blacklist the items from being crafted, spawned or picked up by players. |
| 2 | + |
| 3 | +A simple Unturned plugin that allows server administrators to blacklist specific items from being crafted, picked up, spawned, or stored. |
3 | 4 |
|
4 | 5 | ## Features |
5 | | -- **CanSpawn** - Disable item from spawning or being dropped to the ground |
6 | | -- **CanCraft** - Disable item from being crafted |
7 | | -- **CanTake** - Disable item from being able to be picked up |
8 | | -- **CanStore** - Disable item from being able to be stored in storage like locker |
9 | | -- Optional blacklist bypass permission |
| 6 | + |
| 7 | +- Block items from being crafted by players |
| 8 | +- Prevent items from spawning or being dropped in the world |
| 9 | +- Stop players from picking up specific items |
| 10 | +- Disable storing certain items in containers (lockers, etc.) |
| 11 | +- Permission system to allow certain players to bypass restrictions |
10 | 12 |
|
11 | 13 | ## Configuration |
| 14 | + |
| 15 | +### Basic Settings |
| 16 | + |
| 17 | +- `MessageColor`: Color of plugin messages (default: yellow) |
| 18 | +- `EnableBypassPermission`: Enable/disable the permission bypass system (default: true) |
| 19 | +- `BypassPermission`: Permission node for bypassing restrictions (default: blacklist.bypass) |
| 20 | + |
| 21 | +### Blacklisting Items |
| 22 | + |
| 23 | +Each blacklisted item has the following options: |
| 24 | + |
| 25 | +- `ItemId`: The numerical ID of the item |
| 26 | +- `Name`: Name of the item (optional, for readability) |
| 27 | +- `CanCraft`: If false, players cannot craft this item |
| 28 | +- `CanSpawn`: If false, this item cannot spawn or be dropped |
| 29 | +- `CanTake`: If false, players cannot pick up this item |
| 30 | +- `CanStore`: If false, players cannot store this item in containers |
| 31 | + |
| 32 | +### Example Configuration |
| 33 | + |
12 | 34 | ```xml |
13 | | -<?xml version="1.0" encoding="utf-8"?> |
14 | | -<BlacklistedItemsConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
| 35 | +<BlacklistedItemsConfiguration> |
15 | 36 | <MessageColor>yellow</MessageColor> |
16 | 37 | <EnableBypassPermission>true</EnableBypassPermission> |
17 | 38 | <BypassPermission>blacklist.bypass</BypassPermission> |
18 | 39 | <BlacklistItems> |
19 | 40 | <Item ItemId="1441" Name="Shadowstalker Mk. II" CanCraft="false" CanSpawn="false" CanTake="false" CanStore="false" /> |
20 | | - <Item ItemId="1442" Name="Shadowstalker Mk. II Scope" CanCraft="false" CanSpawn="false" CanTake="false" CanStore="false" /> |
21 | | - <Item ItemId="1443" Name="Shadowstalker Mk. II Drum" CanCraft="false" CanSpawn="false" CanTake="false" CanStore="false" /> |
22 | | - <Item ItemId="1444" Name="Shadowstalker Mk. II Magazine" CanCraft="false" CanSpawn="false" CanTake="false" CanStore="false" /> |
23 | 41 | <Item ItemId="1464" Name="Blindfold" CanCraft="false" CanSpawn="true" CanTake="true" CanStore="true" /> |
24 | 42 | </BlacklistItems> |
25 | 43 | </BlacklistedItemsConfiguration> |
26 | 44 | ``` |
27 | 45 |
|
28 | | -## Translations |
| 46 | +## Messages |
| 47 | + |
| 48 | +You can customize the messages players receive when attempting to interact with blacklisted items: |
| 49 | + |
29 | 50 | ```xml |
30 | | -<?xml version="1.0" encoding="utf-8"?> |
31 | | -<Translations xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
| 51 | +<Translations> |
32 | 52 | <Translation Id="CantBeCrafted" Value="{0} can't be crafted!" /> |
33 | 53 | <Translation Id="CantBeTaken" Value="{0} can't be picked up!" /> |
34 | 54 | <Translation Id="CantBeStored" Value="{0} can't be stored!" /> |
35 | 55 | </Translations> |
36 | | -``` |
| 56 | +``` |
| 57 | + |
| 58 | +## Permissions |
| 59 | + |
| 60 | +- `blacklist.bypass`: Allows players to ignore item restrictions (if enabled in config) |
0 commit comments