EvenMoreFish Documentation

website·Indexed 30 days ago

https://evenmorefish.github.io/EvenMoreFish

Documentation for the EvenMoreFish plugin, featuring guides on custom fish and bait configuration, economy systems, competition types, rarity weights, and dimension fishing. Includes developer resources for the even-more-fish-api and instructions for migrating from version 1.x.

Tokens
13.3K
Snippets
79
Records
111
Agent score
74%

What's inside EvenMoreFish

  1. Overview of Dimension Fishing

    Dimension Fishing allows players to fish in lava or the end's void. Lava fishing is triggered by casting a hook into lava; if the catch fails, the hook burns and plays a configurable sound. Void fishing is triggered when a hook falls a random distance (between 4 and 6 blocks) below the player; if the catch fails, the hook is teleported away and plays a configurable sound.
  2. Understand fish and rarity requirements in EvenMoreFish

    Requirements are rules applied to fish or rarities to limit their appearance. If a fish has no requirements, it can always be caught. If a player fails the requirements for every available fish, an error is logged to the console. Requirements applied to a rarity prevent any fish within that rarity from being caught if the criteria are not met.
  3. Use EvenMoreFish competition placeholders

    The following placeholders provide real-time data about active fishing competitions. All placeholders use the emf identifier.
    %emf_competition_active% - Whether a competition is active (true/false)
    %emf_competition_place_fish_{place}% - The fish in the specified leaderboard place
    %emf_competition_place_player_{place}% - The player in the specified leaderboard place
    %emf_competition_place_size_{place}% - The fish size in the specified leaderboard place
    %emf_competition_time_left% - Time until next competition or remaining time in active one
    %emf_competition_type% - Type of active competition (e.g., LARGEST_FISH, MOST_FISH)
    %emf_competition_type_format% - Formatted type of active competition (e.g., Largest Fish, Most Fish)
  4. Create and configure custom baits

    To create a new bait, create a .yml file in the plugins/EvenMoreFish/baits directory. Every bait configuration file must include a unique id to allow the plugin to identify the bait. All other configuration options are optional.
  5. Restrict fish catches to specific active competitions

    Use the active-competition requirement to ensure a fish can only be caught during specific competitions. If a list of IDs is provided, the requirement passes if the current active competition matches any ID in that list.
    Atlantic Cod:
      requirements:
        active-competition:
          - mainCompetition
          - testCompetition
  6. Restrict fish by WorldGuard or RedProtect regions

    Limit fish to specific regions. Note that this overrides global region settings in config.yml; if a region is whitelisted globally but not listed in the fish's region requirement, the fish will not spawn in that region.
    Atlantic Cod:
      requirements:
        region: FishingRegion
  7. Compile EvenMoreFish plugin from source

    Advanced users can compile the plugin from source to get the most up-to-date version. Note that self-compiled versions may be unstable and are generally not officially supported, though bug reports are encouraged. The resulting .jar file is located in the even-more-fish-plugin/build/libs directory after building.
    git clone https://github.com/EvenMoreFish/EvenMoreFish.git
    cd EvenMoreFish
    ./gradlew build
  8. Verify RewardType availability for fish

    Use the reward-type requirement to ensure a specific reward system (e.g., MONEY) is available before allowing the fish to be caught. This prevents errors when the catch-event attempts to grant a reward that isn't configured.
    Atlantic Cod:
      requirements:
        reward-type:
          - MONEY
      catch-event:
        - MONEY:5000
  9. Contribute to EvenMoreFish documentation

    To contribute to the EvenMoreFish (EMF) documentation, you must submit a Pull Request (PR). The documentation is written using Markdown and MDX (Markdown with JavaScript component support). Files are located in the docs directory of the repository.
    git clone https://github.com/EvenMoreFish/EvenMoreFish.git