RegexingHoppers/README.md

71 lines
2.1 KiB
Markdown
Raw Normal View History

# RegexingHoppers
RegexingHoppers is a Minecraft mod that enhances the functionality of hoppers by allowing the use of regular expressions (regex) to filter items passing through them. This mod adds a new layer of customization and control to item sorting and transportation systems in Minecraft.
## Features
- Use custom names for hoppers as regex patterns to filter items
- Three new commands for testing and managing regex patterns
- Configurable permission levels for commands
## Installation
1. Make sure you have Fabric Loader installed
2. Download the latest version of RegexingHoppers from the releases page
3. Place the downloaded .jar file in your Minecraft mods folder
4. Launch Minecraft with the Fabric profile
## Usage
### Regex Filtering
To use regex filtering on a hopper:
1. Rename the hopper using an anvil with your desired regex pattern
2. Place the renamed hopper in your item system
3. Items matching the regex pattern will be allowed through, while others will be filtered out
### Commands
RegexingHoppers adds the following commands:
1. `/regexhoppers test <regex>`: Test a regex pattern against all item names
2. `/regexhoppers list <regex>`: List all items matching the given regex pattern
3. `/regexhoppers hand`: Display the name of the item in your main hand
By default, all players can use these commands. You can adjust the permission levels in the configuration file.
## Configuration
The mod includes a configuration file (`regexhoppers.json`) located in the `config` folder. You can adjust the permission levels required for each command:
```json
{
"permissions": [
{
"name": "regexhoppers.command.test",
"level": 0
},
{
"name": "regexhoppers.command.list",
"level": 0
},
{
"name": "regexhoppers.command.hand",
"level": 0
}
]
}
```
Adjust the `level` value for each command to set the required permission level. A level of 0 allows all players to use the command.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## Support
If you encounter any issues or have any questions, please open an issue on our GitHub repository.
Happy filtering!