Simple Structure Scanner

FAQ

Do I need to install this on a server?

If you wish the query structure locations, you will need to put the mod on the server as well. However, if you only want to view structure information, you can use it client-side, as long as the mods providing said structures are also installed client-side.

How is the structures list filtered?

The filter box matches both localized and unlocalized structure names. This means you can type the mod name, the name in your selected language, or the default English name. The localization structure is up to the individual providers, but it should generally be gui.structurescanner.structures.<mod_id>.<structure_id>.

The structure wasn't there.

Due to how complex the process is, structures from a mod may prevent or overlap with other structures from another mod. In this case, you should try searching for another structure of the same type. Use the arrows in the right panel to cycle through multiple results.

Features

• GUI accessible via keybinding (default P).
• Preview of structure schematic when available. Click on the preview area to open a larger preview window.
• Support for custom loot tables integrated with JEI: U/Left-click for uses, R/Right-click
• Filterable scrolling list of structures on the left; right panel shows details. for recipes.
  • Live search on the main screen for the nearest selected structure. Double-click a structure in the list to toggle search.
  • Use the Refresh button to re-query structure locations.
  • Cycle through multiple found locations for a structure using the arrow buttons in the right panel.
  • Use the "x" button to blacklist a found location (per structure, per world).
  • Teleport to the found structure (op only) using the TP button.
  • X/Y/Z coordinates are shown for the location, if found.

List of supported structures:

• Vanilla Minecraft structures.
• Dungeons from the Aether mod.
• Some specific structures from AbyssalCraft.
• Ice&Fire's structures (none can be searched for, due to being non-determinstic).
• Custom structures from the Pillar mod.
• Custom structures from the Recurrent Complex mod.

Search/Visbility blacklist

On top of the config blacklist/whitelist (see Config section), there exists a more controlable and fine-grained blacklist system for search and visibility. Visibility is whether the structure will show in the list at all (allowing preview, blocks, entities, loot), while Search is whether the structure will be searchable (arrow pointing to the nearest in-world). It is perfectly reasonable to just use Simple Structure Scanner for the metadata alone, leaving the search disabled. If you want to disable ALL search altogether, I would redirect you to the enableSearch config.

These blacklist are per provider, the id of the provider being matched by file name (see the id of each provider under structure/ or in your own external providers). The blacklists should be placed under minecraft/config/. For example for provider examplepack :

• Visibility blacklist file example: docs/examples/hidden-blacklists/examplepack.txt -> minecraft/config/simplestructurescanner/hidden-blacklists/examplepack.txt
• Search blacklist file example: docs/examples/search-blacklists/examplepack.txt -> minecraft/config/simplestructurescanner/search-blacklists/examplepack.txt

Do note these lists are client-side, because only the search process itself is server-side. Everything else is client-side, meaning any user can modify their own blacklists, if determined enough. However, such user would have have no qualm cheating, in the first place, so this is a best-effort protection.

/sssblacklist can be used to remove entries from these blacklists directly, for example using an item or finishing a quest that allows showing or searching for a specific structure or in a specific dimension.

/sssblacklist hidden handles the vibility blacklist, while /sssblacklist search handles the search blacklist. The provider to pass as argument is the same provider mentioned above, the id that is used for the blacklist file name.

Configs:

• enableSearch: Globally disable search.
• whitelist/blacklist: Configure which structures are allowed/disallowed for searching. Whitelist takes priority over blacklist. Partial matches are supported (e.g., village matches all structures with "village" in their ID or minecraft matches all structures from the Minecraft namespace). To avoid matching too broadly, keep the : separator for namespace matching (e.g., pillar:). Add ;radius to make the entry local, which stops being enforced if the player is within a certain radius of the structure (e.g., minecraft:;100 only blocks vanilla structures until within 100 blocks).
• showBlocks: Show blocks that are part of the structure in the details panel.
• showEntities: Show entities that are part of the structure in the details panel.
• showLootTables: Show loot tables that are part of the structure in the details panel.

Config-driven external providers:

• You can define structure metadata in JSON under minecraft/config/simplestructurescanner/external-providers/. Point each entry to an NBT file (nbtPath) so blocks/layers/entities/loot are automatically parsed from the actual structure NBT data. The .nbt file can be created from in-world structures using the Structure Capture Ruler. It can then be size-optimized using the NBT Tool (see NBT Tools section in the Github repository).
• External provider example (JSON + NBT layout): docs/examples/external-providers/README.md
• Sample provider JSON: docs/examples/external-providers/example_provider.json
• Sample provider, structure, and shared dimension lang entries: docs/examples/en_us.lang

Credits

• Chinese translation: @ZHAY10086
• Structure Capture Ruler's texture: @NerdySpider
• Curseforge Icon: Star Artsy