Explorer's Compass: Project Infinity 0.1 config options

Mirrors each waypoint the compass records into Xaero's Minimap as well. Has no effect when that mod is not installed. The compass keeps a waypoint of its own for every place it locates either way, marked on the direction strip and listed on the waypoints screen; this is about whether the minimap gets a copy.

Draws the direction strip on a panel of its own. Turn this off to leave only the marks, the compass points and the readout, with nothing behind them: they carry their own shadows, and fade out towards the ends of the strip on their own.

How much of the horizon the direction strip covers, in degrees. Lower values spread the marks further apart and make small changes in direction easier to see, higher values keep more of the horizon in view at once. Pair a full width strip with a large span to have the whole horizon on screen at once.

How many waypoints the direction strip marks at once, nearest first, before it stops saying anything and just looks busy.

Marks the waypoints the compass has recorded in this dimension on the direction strip, each in its own color, with the name and distance of whichever lies nearest to straight ahead read out under the strip. The strip stays up for them while a compass is held, or carried where the strip is kept up for a carried compass, whether or not the compass is pointing at anything. Each waypoint can be taken off the strip on its own from the waypoints screen.

The shape a waypoint is marked with on the direction strip, and beside its name on the waypoints screen. BOOKMARK hangs a notched ribbon from the top of the strip; PIN stands a round-headed pin on the bottom of it; FLAG stands a pole with a pennant; DIAMOND puts a small diamond in the middle, which takes the least room. Ex: BOOKMARK, PIN, FLAG, DIAMOND

How wide the direction strip is, in pixels of the scaled interface. A strip wider than the screen is cut down to it, so any large value here makes the strip span the whole width of whatever screen it is drawn on.

How far down from the top of the screen the direction strip is drawn.

Displays Explorer's Compass information on the HUD even while chat is open.

Fills in the strip along the top of the compass screens, which holds the title, the filter field and the filters in force. Turn this off to have it outlined but see through.

Fills in the column of controls beside the list on the compass screens. Turn this off to have it outlined but see through.

Fills in the bar along the bottom of the structure screen, which reports what the compass is doing. Turn this off to have it outlined but see through.

How many waypoints the compass keeps for one world or server before the oldest are forgotten. Set to 0 to keep them all.

Draws the compass information on the HUD on a panel of its own, which keeps it legible against a bright sky or a snowy landscape. Turn this off for plain text.

The line offset for information rendered on the HUD.

The side for information rendered on the HUD. Ex: LEFT, RIGHT

Displays a compass strip at the top of the screen marking the direction of the located structure.

Keeps the direction strip on the HUD while the compass is only carried, rather than only while one is held, so long as the carried one is pointing at a place located in this dimension. Turn this off to have the strip appear only while the compass is in hand. What the panel of compass information does while one is only carried is showOverlayWhileCarried's to say.

Keeps the panel of compass information on the HUD while the compass is only carried, rather than only while one is held. A carried compass reports what it is doing exactly as a held one does: how far the search it is running has got, where the place it points at lies, or that its last search came back empty. Where several are carried, the one pointing at a place located in this dimension is the one the panel speaks for.

Turns a structure preview slowly on its own, so that it is seen from more than one side without being dragged around. The button on the preview screen switches this on and off as well.

How many cells a structure preview may hold before it opens drawn as coloured blocks instead of real ones. Both are one cell to one block; what the coloured tier gives up is the textures, not the detail. Real blocks take longer to assemble into a model, which happens in the background while a coloured stand-in is shown, so this decides which of the two a large structure settles on rather than how long it takes to appear. The button on the preview screen switches between the two for the structure being looked at either way. Raise this to have real blocks on larger structures by default; set it to 0 to open every preview in colours.

How much the compass says about itself in its own tooltip. COMPACT keeps it to what the compass is doing and what follows from that, with the rest a held shift key away; FULL shows all of it at once; NONE leaves the tooltip empty. Whether the coordinates are among what it may show is the server's to decide, not this. Ex: NONE, COMPACT, FULL

Attempts to translate biome names before fixing the unlocalized names. Unlike structures, almost every biome is named by the game itself or by the mod that adds it, so there is rarely anything left to fix up.

Attempts to translate structure names before fixing the unlocalized names. Translations may not be available for all structures.

The color of the waypoints the compass records, as an index into Xaero's Minimap's own color list, which is also the game's list of text colors. Used on the direction strip as well as in the minimap.

Where Xaero's Minimap draws the waypoints this mod mirrors into it. The direction strip marks them in the world either way, so the minimap's own floating labels are one marker too many. WORLD_MAP_ONLY keeps them on the full-screen world map and nowhere else, which is the minimap's own "world map only" visibility; MINIMAP_AND_WORLD lets the minimap draw them everywhere as it did before; HIDDEN leaves them in the minimap's list but switched off there. Applies to every copy made from then on; the button on the waypoints screen changes this too and applies it to the copies already made. Ex: WORLD_MAP_ONLY, MINIMAP_AND_WORLD, HIDDEN

Allows players to announce a located structure to everyone else on the server.

Allows players to see what a structure looks like before searching for one. The server assembles the structure the way world generation would, without placing any of it anywhere, off the server thread, and sends back a small model of it. The most recently viewed structures are kept assembled, so looking at one again costs nothing while it stays in use. Turn it off to have the compass answer that there is nothing to show.

Allows a player to teleport to a located structure when in creative mode, opped, or in cheat mode.

Runs biome searches on threads of their own rather than in slices of the server tick, which finishes them several times sooner and costs the server nothing while they run. A search is shared out over as many threads as searching is allowed, each taking its own share of the ground. This is safe because which biome generates somewhere follows from the world seed and the generator's noise alone, which the game itself samples from its own worldgen threads. Turn it off if a mod that adds a biome source of its own turns out not to be safe to sample from another thread.

Runs structure searches off the server thread, shared out over as many threads as searching is allowed, by working out where a structure would generate the same way world generation decides it instead of asking chunk storage about every location the search looks at. Almost all of what a structure search costs is that question, and asking world generation instead reads no part of the world, so the search leaves the server thread free while it runs and finishes far sooner. The location it settles on is still put to chunk storage before the compass is pointed at it. What this can differ over is ground that was generated under settings that have since changed, such as an old world or a data pack that has been edited: there the compass answers with where a structure would generate now. Turn it off to have every location answered by chunk storage on the server thread, as it was before, and also if a mod that adds structures of its own turns out not to be safe to generate from another thread.

A list of biomes that the compass will not display in the GUI and will not be able to search for. Wildcards work the same way they do for the structure blacklist. Ex: ["minecraft:deep_dark", "minecraft:*ocean*"]

How many locations apart, along each axis, a biome search looks at the heights other than the one it was started at. The height a search starts at is sampled everywhere, since that is where the biome being looked for usually is; the rest of the dimension is sampled on a coarser grid, since a biome that fills the caves covers far more ground than the spacing between two locations. Raising this searches faster but can step over a small cave biome, and 1 samples every height at every location.

How far apart in blocks the locations sampled by a biome search are. Lower values make the search less likely to step over a small biome entirely, higher values let it cover the same area in fewer samples.

How far apart in blocks the heights sampled by a biome search are. Sampling the whole height of a dimension is what makes the biomes that fill the caves findable from the surface. Set to 0 to sample only the height the search was started at, which searches several times faster but only finds the biomes reaching it.

Allows players to view the precise coordinates and distance of a located structure on the HUD, rather than relying on the direction the compass is pointing.

Leaves the structures this world cannot generate out of the compass, rather than offering them and having every search for one report that nothing was found. A structure is only ever placed by a structure set that names it and whose biomes this world actually has, so what this drops is the structures no dimension of this world could place: the ones whose biome tag a data pack has emptied out, the ones a data pack has taken out of every structure set, the ones belonging to no set in the first place, and every structure at once in a superflat world configured without any or in a world generating no structures at all. This is the same rule the compass already searches by, so what it leaves out is exactly what a search could never find. Turn it off to be offered every structure this world's registries hold, whether it can generate or not.

The maximum number of samples to be taken when searching for a biome. A biome can lie anywhere, where a structure can only lie where its placement allows one, so a biome search takes far more samples than a structure search does. Each of them is much cheaper, since which biome generates somewhere follows from the world seed alone and needs no part of the world to have been generated.

How many located structures a compass remembers, so that they can be pointed at again later. The oldest is dropped once this many have been collected. Set to 0 to disable remembering them.

The maximum number of times a player can search for the next instance of a located structure, skipping the locations already found. The collected locations are forgotten and the search starts over from the closest instance again once this many have been collected, and likewise once every instance within the search radius has been collected. Set to 0 to disable searching for further instances and make the compass always locate the nearest one.

The maximum radius that will be searched for a structure. Raising this value will increase search accuracy but will potentially make the process more resource intensive.

The maximum number of samples to be taken when searching for a structure.

The maximum amount of time in milliseconds that searches may spend on the server thread during a single tick. Sampling a location can be expensive, so this caps how much of each tick searching is allowed to consume. This is shared by every search running on the server, which take turns within it, so raising it does not let one player's search crowd out another's. Lower values keep the game responsive while a search is running, higher values complete searches sooner.

The minimum time in milliseconds between searches started by the same player. Search requests arriving faster than this are ignored. This guards against modified clients restarting expensive searches as fast as they can send packets. Set to 0 to disable.

The minimum time in milliseconds between locations shared by the same player, so that sharing cannot be used to flood chat. Set to 0 to disable.

A list of structures that the compass will not display in the GUI and will not be able to search for. Wildcard character * can be used to match any number of characters, and ? can be used to match one character. Ex: ["minecraft:stronghold", "minecraft:endcity", "minecraft:*village*"]

How many cells of a structure preview may be sent. Only the cells that can be seen from outside the structure are ever sent, and a structure whose surface does not fit inside this is shrunk until it does, at which point it is no longer one cell to one block. The default clears every structure the game itself adds by several times over: the largest of them, a bastion, comes to under 60000 solid blocks even counting every piece it could possibly be assembled from, and only part of that is ever visible from outside. A structure that does not fit is named in the log. Previews are sent in pieces and each is built once and then kept, so this is what one costs the first time it is opened rather than what it costs to show.

How many cells across a structure preview may be. The default is large enough that no structure is shrunk to fit it, so a preview is one cell to one block and shows the structure at its own size; lower it to cap how large a preview may be however large the structure is. What actually decides whether a preview is shown one to one is the cell budget below.

The minimum time in milliseconds between teleports requested by the same player. Teleporting loads, and usually generates, the destination chunk, so this keeps a modified client from queueing up that work as fast as it can send packets. Set to 0 to disable.