Component-Based Searching
Searchables is a utility and library mod designed to streamline searching and filtering operations for collections of objects. The tool equips developers with helper utilities to query data based on distinct element components, while also delivering native auto-complete capabilities right out of the box.
Using the library's builder system, developers can create a SearchableType definition for any custom data object. This structure allows the registration of named components as well as a designated default component. When evaluating searches against a collection of entries, queries matching the default component don't require an explicit key name. For more specific queries, users can search across specific component keys. Multi-term searches can be supplied in any arbitrary order. If a search parameter contains spaces or quote marks, the value can be safely wrapped using single quotes, double quotes, or backticks.
Custom UI Edit Box Integration
Beyond data filtering methods, Searchables provides user interface components to facilitate smooth in-game menu integration. Mod developers can implement the AutoCompletingEditBox class directly within their custom screen classes. And this specialized text widget connects directly to a chosen SearchableType and an element supplier to populate real-time suggestions.
The edit box handles several interface behaviors automatically. When suggestions appear, the auto-complete dropdown renders cleanly on top of underlying screen elements. The widget also integrates with mouse scrolling events so users can easily navigate through lengthy suggestion lists. And an attached responder callback recalculates and updates filtered items whenever the text inside the input box changes.
Development and Build Setup
Setting up a local development workspace involves cloning the official repository from GitHub and opening the project within an IDE. Here's the thing, compiling the codebase is accomplished by executing the standard Gradle build command, which generates compiled .jar files within the build/libs/ directory across the common, fabric, and forge subprojects. Community members seeking troubleshooting help or discussion can join the project's Discord server, while technical issues and feature suggestions are submitted through the issue tracker.
Compatibility and Requirements
Searchables is cataloged under the Libraries & APIs and Utility & Quality of Life categories. In terms of side environments, client-side installation is required, and server-side deployment is unsupported. The mod offers support for both the Neoforge and Fabric mod loaders on Minecraft versions 26.3, 26.2, and 26.1.2. One entire project is distributed as open source under the terms of the MIT License.
