Skip to content

Commit 008fb92

Browse files
MrButtersDEVMrButtersDEV
authored
Update README.md
1 parent edf2c99 commit 008fb92

File tree

1 file changed

+61
-65
lines changed

1 file changed

+61
-65
lines changed

‎README.md‎

Lines changed: 61 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,62 @@
11
# AutoPickup
2-
Pick up the items you mine
3-
4-
Support Discord:
5-
For any issues or questions feel free to join our Discord for quick support!
6-
https://discord.gg/ncHH4FP
7-
8-
Other Support Methods:
9-
GitHub and Spigot DM's (@MrButtersDev) are another good place for support. I check them almost daily. For quick and general support Discord is the best option. Although for documenting bugs feel free to create an issue here on GitHub.
10-
11-
[QUOTE]The below documentation was generated using ChatGPT by OpenAI. For further clarification join our discord for support or view an up-to-date "default" of the config.yml file on GitHub.[/QUOTE]
12-
13-
Configuration - config.yml
14-
[QUOTE][/QUOTE][QUOTE]
15-
The [ICODE]msgPrefix[/ICODE] field is a string that represents the message prefix for messages related to the AutoPickup feature. It is displayed in the chat with a specific color code formatting.
16-
17-
The [ICODE]msgAutoPickupEnable[/ICODE] and [ICODE]msgAutoPickupDisable[/ICODE] fields are strings that represent the messages displayed when the player enables or disables the AutoPickup feature, respectively. They are displayed in the chat with a specific color code formatting.
18-
19-
The [ICODE]msgAutoSmeltEnable[/ICODE] and [ICODE]msgAutoSmeltDisable[/ICODE] fields are strings that represent the messages displayed when the player enables or disables the AutoSmelt feature, respectively. They are displayed in the chat with a specific color code formatting.
20-
21-
The [ICODE]msgAutoMobDropsEnable[/ICODE] and [ICODE]msgAutoMobDropsDisable[/ICODE] fields are strings that represent the messages displayed when the player enables or disables the AutoMobDrops feature, respectively. They are displayed in the chat with a specific color code formatting.
22-
23-
The [ICODE]msgAutoEnable[/ICODE] field is a string that represents the message displayed when the AutoPickup feature is automatically enabled. It is displayed in the chat with a specific color code formatting. The [ICODE]doAutoEnableMSG[/ICODE] field is a boolean value that specifies whether the message defined in the [ICODE]msgAutoEnable[/ICODE] field should be displayed or not.
24-
25-
The [ICODE]msgEnabledJoinMSG[/ICODE] field is a string that represents the message displayed when a player joins the game and the AutoPickup feature is automatically enabled. It is displayed in the chat with a specific color code formatting. The [ICODE]doEnabledOnJoinMSG[/ICODE] field is a boolean value that specifies whether the message defined in the [ICODE]msgEnabledJoinMSG[/ICODE] field should be displayed or not.
26-
27-
The [ICODE]msgReload[/ICODE] field is a string that represents the message displayed when the configuration is reloaded. It is displayed in the chat with a specific color code formatting.
28-
29-
The [ICODE]msgFullInv[/ICODE] field is a string that represents the message displayed when the player's inventory is full. It is displayed in the chat with a specific color code formatting. The [ICODE]doFullInvMSG[/ICODE] field is a boolean value that specifies whether the message defined in the [ICODE]msgFullInv[/ICODE] field should be displayed or not.
30-
31-
The [ICODE]titlebar[/ICODE] section contains fields related to the display of a title bar message when the player's inventory is full. The [ICODE]doTitleBar[/ICODE] field is a boolean value that specifies whether the title bar message should be displayed or not. The [ICODE]line1[/ICODE] and [ICODE]line2[/ICODE] fields are strings that represent the two lines of the title bar message. They are displayed in the chat with a specific color code formatting.
32-
33-
The [ICODE]voidOnFullInv[/ICODE] field is a boolean value that specifies whether extra blocks broken by the player should be voided when the AutoPickup feature is enabled and the player's inventory is full.
34-
35-
The [ICODE]usingSilkSpawnerPlugin[/ICODE] field is a boolean value that specifies whether a Silk Spawner plugin is in use preventing players from receiving XP from breaking spawners. Defaulting to true, the plugin assumes your using a silk spawner plugin and will let that plugin manage XP drops for spawners.
36-
37-
The [ICODE]ignoreMobXPDrops[/ICODE] field is a boolean value that represents whether or not Auto Pickup should collect XP from mobs or allow it to drop naturally.
38-
39-
The [ICODE]msgNoperms[/ICODE] field is a string that represents the message displayed when a player does not have permission to run a command. It is displayed in the chat with a specific color code formatting.
40-
41-
The [ICODE]requirePerms[/ICODE] section contains fields that specify whether players require permission to run certain commands. The [ICODE]autopickup[/ICODE] field is a boolean value that specifies whether players require permission to run the [ICODE]/autopickup[/ICODE] command. The [ICODE]auto-reload[/ICODE] field is a boolean value that specifies whether players require permission to run the [ICODE]/auto reload[/ICODE] command.
42-
[/QUOTE]
43-
44-
Blacklist's - blacklist.yml
45-
[QUOTE][/QUOTE][QUOTE]
46-
The [ICODE]doBlacklisted[/ICODE] field is a boolean value that specifies whether the blacklist feature for blocks should be enabled. If set to [ICODE]true[/ICODE], the blocks listed in the [ICODE]Blacklisted[/ICODE] field will be prevented from being picked up by the player.
47-
48-
The [ICODE]doBlacklistedEntities[/ICODE] field is a boolean value that specifies whether the blacklist feature for entities should be enabled. If set to [ICODE]true[/ICODE], the entities listed in the [ICODE]BlacklistedEntities[/ICODE] field will not drop items when killed by the player.
49-
50-
The [ICODE]Blacklisted[/ICODE] field is a list of block names that should be prevented from being picked up by the player when the blacklist feature is enabled.
51-
52-
The [ICODE]BlacklistedEntities[/ICODE] field is a list of entity names that should not drop items when killed by the player when the blacklist feature is enabled.
53-
54-
The [ICODE]BlacklistedWorlds[/ICODE] field is a list of world names in which the blacklist features should be applied.
55-
[/QUOTE]
56-
57-
Placeholder Configuration - papi.yml
58-
[QUOTE][/QUOTE][QUOTE]
59-
The [ICODE]papi[/ICODE] section contains fields related to the PlaceholderAPI plugin. The enabled field is a subfield that has two subfields of its own, [ICODE]true[/ICODE] and [ICODE]false[/ICODE]. These subfields are strings that represent messages displayed when the AutoPickup plugin is enabled or disabled, respectively. They are displayed in the chat with a specific color code formatting.
60-
61-
Available PAPI Placeholders:
62-
63-
[code=Kotlin][>] %autopickup_autoenabled%
64-
[>] %autopickup_dropsenabled%
65-
[>] %autopickup_autosmeltenabled%[/code]
66-
[/QUOTE]
2+
Pick up the items you mine
3+
4+
### Support Discord:
5+
For any issues or questions, feel free to join our Discord for quick support!
6+
[https://discord.gg/ncHH4FP](https://discord.gg/ncHH4FP)
7+
8+
### Other Support Methods:
9+
GitHub and Spigot DMs (`@MrButtersDev`) are another good place for support. I check them almost daily. For quick and general support, Discord is the best option. However, for documenting bugs, feel free to create an issue on GitHub.
10+
11+
> The below documentation was generated using ChatGPT by OpenAI. For further clarification, join our Discord for support or view an up-to-date "default" of the `config.yml` file on GitHub.
12+
13+
## Configuration - `config.yml`
14+
> The `msgPrefix` field is a string that represents the message prefix for messages related to the AutoPickup feature. It is displayed in the chat with specific color code formatting.
15+
>
16+
> The `msgAutoPickupEnable` and `msgAutoPickupDisable` fields are strings that represent the messages displayed when the player enables or disables the AutoPickup feature, respectively. They are displayed in the chat with specific color code formatting.
17+
>
18+
> The `msgAutoSmeltEnable` and `msgAutoSmeltDisable` fields are strings that represent the messages displayed when the player enables or disables the AutoSmelt feature, respectively. They are displayed in the chat with specific color code formatting.
19+
>
20+
> The `msgAutoMobDropsEnable` and `msgAutoMobDropsDisable` fields are strings that represent the messages displayed when the player enables or disables the AutoMobDrops feature, respectively. They are displayed in the chat with specific color code formatting.
21+
>
22+
> The `msgAutoEnable` field is a string that represents the message displayed when the AutoPickup feature is automatically enabled. It is displayed in the chat with specific color code formatting. The `doAutoEnableMSG` field is a boolean value that specifies whether the message defined in the `msgAutoEnable` field should be displayed or not.
23+
>
24+
> The `msgEnabledJoinMSG` field is a string that represents the message displayed when a player joins the game and the AutoPickup feature is automatically enabled. It is displayed in the chat with specific color code formatting. The `doEnabledOnJoinMSG` field is a boolean value that specifies whether the message defined in the `msgEnabledJoinMSG` field should be displayed or not.
25+
>
26+
> The `msgReload` field is a string that represents the message displayed when the configuration is reloaded. It is displayed in the chat with specific color code formatting.
27+
>
28+
> The `msgFullInv` field is a string that represents the message displayed when the player's inventory is full. It is displayed in the chat with specific color code formatting. The `doFullInvMSG` field is a boolean value that specifies whether the message defined in the `msgFullInv` field should be displayed or not.
29+
>
30+
> The `titlebar` section contains fields related to the display of a title bar message when the player's inventory is full. The `doTitleBar` field is a boolean value that specifies whether the title bar message should be displayed or not. The `line1` and `line2` fields are strings that represent the two lines of the title bar message. They are displayed in the chat with specific color code formatting.
31+
>
32+
> The `voidOnFullInv` field is a boolean value that specifies whether extra blocks broken by the player should be voided when the AutoPickup feature is enabled and the player's inventory is full.
33+
>
34+
> The `usingSilkSpawnerPlugin` field is a boolean value that specifies whether a Silk Spawner plugin is in use, preventing players from receiving XP from breaking spawners. Defaulting to true, the plugin assumes you're using a silk spawner plugin and will let that plugin manage XP drops for spawners.
35+
>
36+
> The `ignoreMobXPDrops` field is a boolean value that represents whether or not Auto Pickup should collect XP from mobs or allow it to drop naturally.
37+
>
38+
> The `msgNoperms` field is a string that represents the message displayed when a player does not have permission to run a command. It is displayed in the chat with specific color code formatting.
39+
>
40+
> The `requirePerms` section contains fields that specify whether players require permission to run certain commands. The `autopickup` field is a boolean value that specifies whether players require permission to run the `/autopickup` command. The `auto-reload` field is a boolean value that specifies whether players require permission to run the `/auto reload` command.
41+
42+
## Blacklists - `blacklist.yml`
43+
> The `doBlacklisted` field is a boolean value that specifies whether the blacklist feature for blocks should be enabled. If set to `true`, the blocks listed in the `Blacklisted` field will be prevented from being picked up by the player.
44+
>
45+
> The `doBlacklistedEntities` field is a boolean value that specifies whether the blacklist feature for entities should be enabled. If set to `true`, the entities listed in the `BlacklistedEntities` field will not drop items when killed by the player.
46+
>
47+
> The `Blacklisted` field is a list of block names that should be prevented from being picked up by the player when the blacklist feature is enabled.
48+
>
49+
> The `BlacklistedEntities` field is a list of entity names that should not drop items when killed by the player when the blacklist feature is enabled.
50+
>
51+
> The `BlacklistedWorlds` field is a list of world names in which the blacklist features should be applied.
52+
53+
## Placeholder Configuration - `papi.yml`
54+
> The `papi` section contains fields related to the PlaceholderAPI plugin. The `enabled` field is a subfield that has two subfields of its own, `true` and `false`. These subfields are strings that represent messages displayed when the AutoPickup plugin is enabled or disabled, respectively. They are displayed in the chat with specific color code formatting.
55+
>
56+
> **Available PAPI Placeholders:**
57+
>
58+
> ```kotlin
59+
> %autopickup_autoenabled%
60+
> %autopickup_dropsenabled%
61+
> %autopickup_autosmeltenabled%
62+
> ```

0 commit comments

Comments
 (0)