promotional bannermobile promotional banner

JustEnoughGuide

[Slimefun Addon] Recipe Completion, Pinyin Search, Real-Time Search, UI Optimization, Bookmark System, EMC Compatibility Display, Guide Keybinding, Extra-Large Recipe Display, Custom Item Group Sorting Support

JustEnoughGuide (JEG for short) is a Slimefun addon for Minecraft that significantly enhances the functionality and user experience of the original Slimefun guide book. This plugin aims to provide a more intuitive and efficient way to access Slimefun item recipes and information for Minecraft servers.

Key Enhanced Features
1. Enhanced User Interface
Custom Layout System: Fully customize the guide book interface layout through configuration files
Improved Visual Design: Clearer item display and navigation system
Multi-page Support: Support for more complex interface designs with more functional areas
2. Powerful Search Functionality
Pinyin Search: Search Chinese item names using pinyin
Real-Time Search (RTS): Search items in real-time within an anvil interface without typing complete names
Smart Filtering: Support for blacklist and ban list to control which items can be searched
Character Mapping: Allow searching across similar characters (e.g. "粘黏" and "荧萤")
3. Bookmark System
Personal Collections: Players can bookmark frequently used items for quick access
Persistent Storage: Bookmark data is saved in each player's personal backpack
4. Multiple Guide Options
Beginner's Guide: Provide more friendly guidance for new players
EMC Display: Display EMC values of items (for related addons)
Recipe Sharing: Allow players to share item recipes
Recursive Recipe Filling: Automatically fill sub-recipes in recipes
5. Custom Item Groups
Flexible Grouping System: Support for creating custom item groups
Group Reordering: Rearrange the display order of item groups
Hidden Groups: Hide specific item groups from appearing in the guide
6. Advanced Recipe Display
Recipe Completion: Provide recipe completion functionality to help players understand the complete crafting process
Large Recipe Support: Support for displaying complex multi-block structure recipes
Recipe Type Display: Clearly identify the crafting type of each recipe
Configuration Options
The plugin provides extensive configuration options that allow server administrators to fully customize the guide book's behavior:

guide:
  survival-guide-title: "..."     # Survival mode guide title
  cheat-guide-title: "..."        # Cheat mode guide title

improvements:
  pinyin-search: true             # Enable pinyin search
  bookmark: true                  # Enable bookmark functionality
  rts-search: true                # Enable real-time search
  beginner-option: true           # Enable beginner option

Interface Customization
Through the custom-format section in the configuration file, you can fully customize various interface layouts:

Main interface layout
Nested group interface
Sub-group interface
Recipe display interface
Settings interface, etc.
Each interface can be defined with character mapping to position different elements, such as Background(B), Back button(b), Search(S), Item Groups(G), etc.

Localization Support
The plugin includes Chinese translations for a large number of Slimefun addons, ensuring that all items and groups have appropriate Chinese names displayed.

Technical Features
High Performance: Uses asynchronous processing and caching mechanisms to ensure smooth experience
Easy Configuration: All features can be adjusted through configuration files
Modular Design: Independent functional modules that can be enabled/disabled as needed
Usage
Place the plugin in the server's plugins folder
Start the server to generate configuration files
Modify the configuration files as needed
Restart the server to apply the configuration
All improvements will automatically apply when players use the Slimefun guide book
Contributing
Feel free to submit issues and pull requests to help improve this plugin. Please also review our Code of Conduct.

License
This project is open-sourced under the GPLv3 License.

JustEnoughGuide Team

profile avatar
Owner
  • 1
    Projects
  • 2
    Downloads