From bf3fa4b2173d2fc51a23d7ab8566ce1c840ff435 Mon Sep 17 00:00:00 2001 From: Chaoscaot Date: Thu, 16 Mar 2023 16:32:14 +0100 Subject: [PATCH] Github migration --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 00a9eac..ff99acd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # schemsearch -### A simple CLI tool to search in Sponge Schematic files +### A *simple* CLI tool to search in Sponge V2 Schematic files --- @@ -10,3 +10,47 @@ | Block data less search | ✅ | | Tile entities search | ❌ | | Entities search | ❌ | + +--- + +## 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 +``` + +### 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 +``` + +--- + +## 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. +You shouldn't enable this feature unless you know what you are doing. + +--- + +## License +This project is licensed under the AGPL-3.0 License. See the [LICENSE](LICENSE) file for details.