1
0
Mirror von https://github.com/Chaoscaot/schemsearch synchronisiert 2024-11-19 10:20:08 +01:00
schemsearch/README.md

67 Zeilen
1.8 KiB
Markdown

2023-03-08 15:47:51 +01:00
# schemsearch
2023-04-28 00:28:34 +02:00
### A *simple* CLI tool to search in Sponge Schematic files
2023-03-08 15:47:51 +01:00
---
## WARNING: This is a work in progress and is really simple right now. It will be improved in the future.
2023-04-01 11:07:12 +02:00
| Feature | Status |
|---------------------------|--------|
| Block search | ✅ |
| Block data less search | ✅ |
| Tile entities data search | ❌ |
| Entities search | ❌ |
2023-03-16 16:32:14 +01:00
---
## Reasoning
As a Developer of the [SteamWar.de Minecraft server](https://steamwar.de) we needed a way to search for schematics that contain a specific pattern.
Focused on "competitive Redstone building" stealing of other players techniques is a big problem, so this is a little side project of mine.
---
## Usage
The tool takes a pattern as it's first parameter, this should be a valid Sponge V2 Schematic File.
The second parameter is a list of schematics or directories to search in.
```bash
schemsearch-cli <pattern> <schematic...>
```
### Examples
Simple search
```bash
schemsearch-cli tests/endstone.schem tests/simple.schem
```
### Help
The rest of the valid parameters can be found by using the help command.
```bash
schemsearch-cli --help
```
---
2023-03-16 21:08:56 +01:00
## Roadmap
2023-04-01 11:07:12 +02:00
A list of features that are planned to be implemented in the future. In order of priority.
2023-03-16 21:08:56 +01:00
2023-04-01 11:07:12 +02:00
- [ ] Use AVX2 for faster search
- [ ] Tile entities data search
2023-03-16 21:08:56 +01:00
- [ ] Entities search
2023-04-01 11:07:12 +02:00
- [ ] McEdit Schematic support
2023-03-16 21:08:56 +01:00
---
2023-03-16 16:32:14 +01:00
## Building
This project is build using Rust for the CLI and library. It can be built using Cargo.
```bash
cargo build --release
```
### Features: schemsearch-sql
This feature is not enabled by default as it is a specific implementation for the SteamWar.de Minecraft server.
2023-03-16 19:15:46 +01:00
**You shouldn't enable this feature unless you know what you are doing.**
2023-03-16 16:32:14 +01:00
---
## License
2023-03-16 19:15:46 +01:00
This project is licensed under the AGPL-3.0 License. See the [LICENSE](LICENSE.txt) file for details.