Перейти к содержимому
Mineforgian

Scythe

Auto-replant harvested crops!

8K загрузок64 подписчиковMITpaperpurpur

Обновлён 19 мая 2025 г. · опубликован 15 августа 2022 г.

Scythe - Auto-Replant, Right-Click-Harvest plugin

Modrinth Downloads Discord

Features

  • Automatically replant crops after they are harvested
  • Right-click to harvest fully grown crops
  • Crouch in order to break crops without having to toggle the functionality off
  • Configuration options to customize how you'd like the plugin to work on your server

Commands

  • /scythe toggle: Toggles the automatic replanting and right-click harvesting feature for the player who executed the command. This requires the scythe.toggle permission.
  • /scythe reload: Reloads the configuration for the plugin. This requires the scythe.reload permission.

Permissions

  • scythe.use : Base permission for access to Scythe functionality.
  • scythe.use.harvest : Allows a player to harvest blocks using scythe functionality
  • scythe.use.replant : Allows a player to auto-replant crops using scythe functionality
  • scythe.toggle : Allows the player to toggle the feature for themselves using the /scythe toggle command.
  • scythe.reload : Allows the player to reload the configuration using the /scythe reload command.

Config

Note, generated config does not have this many comments lol, this is just for the README/description

#Scythe
auto-replant:
  enabled: true # Should crops automatically be replanted?
  require-seeds: false # Should the user be required to have seeds in their inventory? Note: will consume seeds
  require-tool: false # Should the user be required to use a specific tool?
  delay-ticks: 1 # How long in ticks after breaking the block should it be replanted? (20 ticks per second, without lag)
right-click-harvest:
  enabled: true # Should users be able to right-click to harvest blocks?
  require-tool: false # Should users be required to use a specific tool?
#Only applies if "require-tool" is true in any of the above categories
tools:
  enabled-tools: # If users are required to use a specific tool, which tools are valid?
    - "minecraft:wooden_hoe"
    - "minecraft:stone_hoe"
    - "minecraft:iron_hoe"
    - "minecraft:golden_hoe"
    - "minecraft:diamond_hoe"
    - "minecraft:netherite_hoe"
  # Item models should be declared like "namespace:id"
  required-item-models: [ ] # Do you have any specific item models you're using on tools that make them look different? If so, declare them here
  # Note: In vanilla, harvesting normally crops does NOT use durability.
  # This will cause the tool to lose durability on right-click harvest ONLY
  durability:
    harvest-uses-durability: false # Should right-click-harvest make tool durability go down?
    replant-uses-durability: false # Should auto-replant make tool durability go down?
    prevent-tool-break: true # If either of the two above are set to 'true', do you want to prevent the plugin from working if a tool is low on durability, to prevent users from accidentally breaking their tools?
    minimum-durability: 10 # If the above is set to true, how low should durability be when the plugin stops working?
# Please choose a sound from this list: https://jd.papermc.io/paper/1.21.4/org/bukkit/Sound.html
sounds:
  enabled: true # Should sounds be played when a user breaks or auto-replants a crop?
  break-sound: BLOCK_CROP_BREAK # Which sound should be played when a crop is broken?
  plant-sound: ITEM_CROP_PLANT # Which sound should be played when a crop is replanted?
  # between 0 and 2
  volume: 1.0 # How loud should it be?
  # between 0 and 2
  pitch: 1.0 # How high-pitched should it be?
# Please choose a particle from this list: https://jd.papermc.io/paper/1.20/org/bukkit/Particle.html
particles:
  harvest:
    enabled: true # Should particles show when a user right-click-harvests a block?
    particle: BLOCK # Which particle should show?
    count: 40 # How many particles should spawn? This will wildly depend on the selected particle
    # how far from the center particles should go, in blocks
    spread: 0.5
  replant:
    enabled: true  # Should particles show when a block is auto-replanted?
    particle: HAPPY_VILLAGER # Which particle should show?
    count: 2 # How many particles should spawn? This will wildly depend on the selected particle
    spread: 0.5 # how far from the center should particles go, in blocks
# Crops the plugin should work on, list of materials is here: https://jd.papermc.io/paper/1.21.4/org/bukkit/Material.html
# Note, the material must have the BlockData of 'Ageable' - note, most other ageable blocks in the list don't work as intended.
allowed-crops:
  - BEETROOTS
  - CARROTS
  - COCOA
  - NETHER_WART
  - POTATOES
  - WHEAT
  # - PUMPKIN_STEM
  # - MELON_STEM

API

HarvestEvent - Cancellable

Method Returns Description
getPlayer() Player Returns the player who triggered the harvest.
getBlock() Block Returns the crop block being harvested.
isCancelled() boolean Checks if the event is cancelled.
setPlayer(Player) void Updates the player associated with the event.
setBlock(Block) void Updates the block involved in the event.
setCancelled(boolean) void Cancels or un-cancels the event.
getHandlers() HandlerList Bukkit-required handler method.
getHandlerList() HandlerList Bukkit-required static handler method.

ReplantEvent - Cancellable

Method Returns Description
getPlayer() Player Returns the player who triggered the replanting.
getBlock() Block Returns the block being replanted.
getBlockData() BlockData Returns the BlockData being applied to the replanted block.
isCancelled() boolean Checks if the event is cancelled.
setPlayer(Player) void Updates the player associated with the event.
setBlock(Block) void Updates the block involved in the event.
setBlockData(BlockData) void Updates the BlockData for the replanted block.
setCancelled(boolean) void Cancels or un-cancels the event.
getHandlers() HandlerList Bukkit-required handler method.
getHandlerList() HandlerList Bukkit-required static handler method.

Maven


<repository>
    <id>modrinth-repo</id>
    <url>https://api.modrinth.com/maven/</url>
</repository>

<dependency>
<groupId>maven.modrinth</groupId>
<artifactId>scythe</artifactId>
<version>4.0</version>
<scope>provided</scope>
</dependency>

Gradle

exclusiveContent {
    forRepository { maven { url = "https://api.modrinth.com/maven" } }
    filter { includeGroup "maven.modrinth" }
}

dependencies {
    compileOnly 'maven.modrinth:scythe:4.0'
}

Support

If you need any help with the Scythe plugin, please open an issue on the GitHub repository or join our Discord server for support.

Версии

ВерсияКаналИграЗагрузчикиДатаСкачать
6.1.0Релиз26.1, 26.1.1, 26.1.2, 26.2paper, purpur19 мая 2025 г.Скачать (75 КБ)
6.0.0Релиз1.21.4, 1.21.5paper, purpur3 марта 2025 г.Скачать (67 КБ)
5.2.1Релиз1.21.3paper, purpur17 ноября 2024 г.Скачать (55 КБ)
5.2.0Релиз1.21.3paper, purpur11 ноября 2024 г.Скачать (55 КБ)
5.1.1Релиз1.20.5, 1.20.6, 1.21paper, purpur29 июня 2024 г.Скачать (55 КБ)
5.1Релиз1.20.5, 1.20.6, 1.21paper, purpur25 июня 2024 г.Скачать (55 КБ)
5.0Релиз1.20.5, 1.20.6paper, purpur29 апреля 2024 г.Скачать (54 КБ)
4.0Релиз1.19.1, 1.19.2, 1.19.3, 1.19.4paper, purpur28 мая 2023 г.Скачать (54 КБ)
3.1Релиз1.19, 1.19.1, 1.19.2, 1.19.3paper, purpur5 января 2023 г.Скачать (50 КБ)
3.0Релиз1.19, 1.19.1, 1.19.2, 1.19.3paper, purpur17 декабря 2022 г.Скачать (50 КБ)
2.0Релиз1.18.2, 1.19, 1.19.1, 1.19.2paper, purpur1 октября 2022 г.Скачать (50 КБ)
1.0Релиз1.18.2, 1.19, 1.19.1, 1.19.2paper, purpur15 августа 2022 г.Скачать (20 КБ)

Ченджлог

6.1.0Релиз26.1.1, 26.1.2, 26.2 · 19 мая 2025 г.
  • Added the ability to create/require a custom 'scythe' item, note that if this option is enabled, it will override the other tool options.
  • Added command /scythe-item for this, with permissions scythe.item and scythe.item.others for if someone should be able to send the item to another player
  • Config has a command cooldown, can be bypassed by having the scythe.bypass.cooldown permission

Please note that if you use the Custom Scythe item, old versions will continue to be valid even after you have updated the config. Checks are done on a tag on the item so the item cannot be faked, and old versions will remain valid. Currently the way around this for things like crates and stuff would be to use the /scythe-item <player> as a console command, but I will be trying to figure out a better solution for those things

6.0.0Релиз1.21.4, 1.21.5 · 3 марта 2025 г.

Changelog - 6.0.0

⚠ Important, Config Overhaul ⚠

This update introduces a complete rewrite of the config file. The new config is meant to be clearer, more flexible, and easier to maintain and add new features to.

⚠ Breaking Changes ⚠

  • Old values will NOT automatically migrate.
  • While the plugin will add the new options to your old config, the new comments will not carry over and everything will be put at the top, which will make the file look confusing
  • It is strongly recommended to delete or move your existing config to allow the plugin to generate a new one

Changes

  • Removed left-click and right-click categories in favor of auto-replant and right-click-harvest categories

    • Auto-replant configurations will now be applied regardless of which way the block was broken. Dividing into left and right click added a level of complexity that became exponentially difficult to manage as more features were added.
    • New options
      • require-seeds - whether auto-replanting requires the player to have seeds in their inventory. Will consume seeds.
      • delay-ticks - how long to delay replanting, default 1 tick.
  • Moved and renamed all tool configurations to new tools section

    • replant-tools and replant-tools-item-models are now in this section and renamed to enabled-tools and required-item-models
  • Added the ability to take away tool durability on harvest and replant

    • Please note, this does not affect blocks harvested in the vanilla way, as vanilla harvesting does not remove tool durability.
    • New options are
      • harvest-uses-durability - right-click-harvest will use tool durability
      • replant-uses-durability - automatic replanting will use tool durability
      • prevent-tool-break - whether the plugin will prevent harvest or auto-replant if a tool is below a certain durability threshold
      • minimum-durability - the minimum durability for the previous option
  • Moved and renamed all sound configurations to new sounds section

    • play-sounds has been renamed to enabled under the sounds section
    • sound has been renamed to break-sound
    • sound-volume has been renamed to volume
    • sound-pitch has been renamed to pitch
    • New option has been added: plant-sound
  • Moved and renamed all particle configurations to new particles section

    • break-particles has been renamed to enabled under harvest in the particles section
    • particle-count has been renamed to count under harvest in the particles section
    • particle has been moved under harvest in the particles section
    • New options:
      • harvest section:
        • spread - how far from the center particles should go
      • replant section:
        • enabled - whether replant particles are enabled
        • particle - what particle to use for replant particles
        • count - how many particles to spawn
        • spread - how far from the center particles should go
5.2.1Релиз1.21.3 · 17 ноября 2024 г.
  • Fix broken permission check for /scythe toggle causing the command to not work at all
  • Tested on 1.21.3
5.2.0Релиз1.21.3 · 11 ноября 2024 г.
  • Adds MCMMO compatibility from PR 5
  • Updated to 1.21.3
5.1.1Релиз1.20.5, 1.20.6, 1.21 · 29 июня 2024 г.
  • Fixes the mappings so that paper will not remap it.
  • No other changes
5.1Релиз1.20.5, 1.20.6, 1.21 · 25 июня 2024 г.
  • Adds left-click-replant option, defaults to true
  • Merges #4
5.0Релиз1.20.5, 1.20.6 · 29 апреля 2024 г.
  • Update to work on 1.20.5
  • Adds a locale file
  • Any messages that have been altered will need to be changed in the new file locale.yml
  • BLOCK_DUST no longer exists, a new particle will need to be chosen if that is the one being used
  • Small internal changes
4.0Релиз1.19.2, 1.19.3, 1.19.4 · 28 мая 2023 г.

Major version bump

Now version 4.0 - you will need to delete and reload your config, or get the config values from here

⚠️ Functionality previously provided by scythe.use has now been divided into scythe.use.harvest and scythe.use.replant - if you want someone to have access to both harvesting and replanting, they must now have both permissions

What's changed:

  • Changes API dependency version to 1.19
  • Adds event for harvesting
  • Adds permission for harvesting
  • Adds event for replanting
  • Adds permission for replanting
  • Adds event for toggle
  • Adds configuration for sound
  • Adds configuration for sound's pitch
  • Adds configuration for sound's volume
  • Adds configuration for particle
  • Adds configuration for particle quantity
  • Adds configuration for tool requirement for interact-harvest
  • Adds configuration for tool requirement for auto-replant
  • Adds configuration for tool list
  • Refactors new brand name
  • Fixes sub-commands tab-completion not respecting permissions
  • Adjusts sub-command logic

Adds API, currently importable through modrinth

Javadocs

Maven

<repository>
  <id>modrinth-repo</id>
  <url>https://api.modrinth.com/maven/</url>
</repository>

<dependency>
  <groupId>maven.modrinth</groupId>
  <artifactId>scythe</artifactId>
  <version>4.0</version>
  <scope>provided</scope>
</dependency>

Gradle

exclusiveContent {
    forRepository { maven { url = "https://api.modrinth.com/maven" } }
    filter { includeGroup "maven.modrinth" }
}

dependencies {
    compileOnly 'maven.modrinth:scythe:4.0'
}

Комментарии

Загружаем…