Config

# Developer: @Xiao-MoMi
# Wiki: https://mo-mi.gitbook.io/xiaomomi-plugins/
config-version: '28'

# Debug
debug: false

# BStats
metrics: true

# Check updates
update-checker: true

# Available locales: english
lang: english

# Mechanic settings
mechanics:

  # Specifies the conditions required for the plugin mechanics to work.
  # Here, the type is !world, which implies the plugin won't work in
  # the world named 'blacklist_world'.
  mechanic-requirements:
    world_requirement:
      type: '!world'
      value:
        - blacklist_world

  # Configures global events for hook/bait/rod/loot
  # which would help you reduce duplicated lines
  global-events:
    hook: {}
    bait: {}
    loot:
      success:
        title_action:
          type: random-title
          value:
            titles:
              - '<green>GG!</green>'
              - '<green>Good Job!</green>'
            subtitles:
              - 'You caught a {nick}'
              - 'Whoa! Nice catch!'
              - 'Oh {nick} here we go!'
              - 'Let''s see what it is!'
            fade-in: 20
            stay: 30
            fade-out: 10
          chance: 1.0
      failure:
        title_action:
          type: random-title
          value:
            titles:
              - '<red>Be concentrated!</red>'
              - '<red>What a pity!</red>'
              - '<red>Try next time!</red>'
              - '<red>Bad luck</red>'
            subtitles:
              - 'The fish escaped...'
            fade-in: 20
            stay: 30
            fade-out: 10
          chance: 1.0
    rod:
      land:
        priority_action:
          type: priority
          value:
            priority_1:
              conditions:
                lava-fishing: true
              actions:
                fake_item_action:
                  type: fake-item
                  value:
                    duration: 35
                    position: hook
                    item: util:lava_effect
                    y: 0
                    x: 0
                    z: 0
            priority_2:
              conditions:
                lava-fishing: false
              actions:
                fake_item_action:
                  type: fake-item
                  value:
                    duration: 35
                    position: hook
                    item: util:water_effect
                    y: 0
                    x: 0
                    z: 0

  # Global properties which would help you reduce duplicated lines
  global-loot-property:
    show-in-fishfinder: true
    disable-stat: false
    disable-game: false
    instant-game: false

  # Fishing bag is where players can store their baits, utils, hooks and rods (Loot optional)
  fishing-bag:
    # Enable
    enable: true
    # Fishing bag container title
    bag-title: '<blue>{player}''s Fishing Bag</blue>'
    # Can fishing bag store fishing loots?
    can-store-loot: false
    # Other whitelist-items
    whitelist-items:
      - fishing_rod

  # Lava fishing settings
  # To modify vanilla fishing time, you should edit paper-world-defaults.yml where there's a section called fishing-time-range
  lava-fishing:
    # ticks
    min-wait-time: 100
    max-wait-time: 600

  # Competition settings
  competition:
    # Use redis for cross server data synchronization
    redis-ranking: false
    # Increase this value would allow you to use more placeholders like {4_player} {5_score} in sacrifice of some performance
    placeholder-limit: 3

# Other settings
other-settings:
  # It's recommended to use MiniMessage format. If you insist on using legacy color code "&", enable the support below.
  legacy-color-code-support: false

  # Thread pool settings
  thread-pool-settings:
    # The size of the core Thread pool, that is, the size of the Thread pool when there is no task to execute
    # Increase the size of corePoolSize when you are running a large server with many players fishing at the same time
    corePoolSize: 10
    # The maximum number of threads allowed to be created in the Thread pool. The current number of threads in the Thread pool will not exceed this value
    maximumPoolSize: 10
    # If a thread is idle for more than this attribute value, it will exit due to timeout
    keepAliveTime: 30

  # Event priority: MONITOR HIGHEST HIGH NORMAL LOW LOWEST
  event-priority: NORMAL

  # Save the data from cache to file periodically to minimize the data loss if server crashes
  # -1 to disable
  data-saving-interval: 600

  # Lock player's data if a player is playing on a server that connected to database
  # If you can ensure low database link latency and fast processing, you can consider disabling this option to improve performance
  lock-data: true

  # Requires PlaceholderAPI to work
  placeholder-register:
    '{date}': '%server_time_yyyy-MM-dd-HH:mm:ss%'

  # CustomFishing supports using items/blocks from other plugins
  # If items share the same id, they would inherit the effects
  # The example is at the end if this page
  item-detection-order:
    - CustomFishing
    - vanilla
  block-detection-order:
    - vanilla

  # Custom durability format
  custom-durability-format:
    - ''
    - '<gray>Durability</gray><white>: {dur} <gray>/</gray> {max}</white>'

  # Offset characters' unicodes
  # Never edit this unless you know what you are doing
  offset-characters:
    font: customfishing:offset_chars
    '1': 
    '2': 
    '4': 
    '8': 
    '16': 
    '32': 
    '64': 
    '128': 
    '-1': 
    '-2': 
    '-4': 
    '-8': 
    '-16': 
    '-32': 
    '-64': 
    '-128': 

Item Detection Order

If you keep the same key in CustomFishing and another compatible plugin, the item got from the plugin would inherit the effects from CustomFishing.

If you are using MMOItems, please use Capital letters for instance "BONE_ROD" becuase MMOItems capitalizes item IDs.

Take ItemsAdder for example:

CustomFishing config

item-detection-order:
  - ItemsAdder
  - CustomFishing
  - vanilla

bone_rod:
  effects:
    lava:
      type: lava-fishing

ItemsAdder config

bone_rod:
  resource:
    material: FISHING_ROD
    generate: false
    model_path: item/rod/bone_fishing_rod
    model_id: 50005

Compatibilities

pageCompatibility