Minecraft Forums

===============================================================================
=== PLEASE TAKE A FEW MINUTES TO READ THE README :smile.gif: ===
===============================================================================

Thank you for taking the time to try out Advanced Compass.

Advanced Compass was inspired by the lack of Optifine support in the Finder Compass mod originally released by AtomicStryker on http://www.minecraftforum.net/. You can find his version HERE (http://www.minecraftforum.net/topic/189739-19pre3-finder-compass-diamonds-dungeons-any-block/). The biggest difference between our two releases is that I do not require any other mod for this to work. You can use this with any of the popular HD texture patch mods (Optifine and MCPatcher) or without any mod at all and just with an unmodded Minecraft.

It behaves almost identical to its cousin with a few minor differences. Basically, in game, you take your compass with you while you mine and when you are within a predefined range of a specified block (diamond, gold, mob spawner, chest, etc...) a unique needle on the compass will point you in the direction of that block. There is a simple configuration file that seems more complex than it really is but once you take the time to read the instructions in the file you will see that it is really quite simple.

A note about using this in SMP (multiplayer). While this, or any client mod, can not be directly detected you can be found out. The detection that works to find people running X-Ray mods will also detect you using this. This holds true for any mod (Finder Compass included) that helps you find rare blocks / minerals. So please take note of this and just don't cheat.

Right now I have left the default spawn needle in the compass. I am planning to add additional configuration options later on that will allow for additional needles that point to different areas. A north needle, your home, or any waypoint possibly. Those are all possibilitied for the future. Let me know what you think.


Installation:
Pick the appropriate zip file according to your needs (see post) and follow the normal instructions for installing a mod. Make sure that you install this mod AFTER you have installed you HD texture mod. So install Optifine or run MCPatcher BEFORE installing this mod. Otherwise it will not work. If you are just running an unmodified Minecraft or you do not have a HD texture mod installed you can install this anytime. Once you have installed Advanced Compass you should run Minecraft once to generate the default configuration file located in your minecraft folder. Read the instructions in that file for additional information.


The default configuration file (advanced_compass.cfg) is generated automatically inside of the minecraft folder on the first run of the mod. If you ever mess up the file you can just delete it and it will be automatically created again for you.

# ================================================================================
# = Advanced Compass
# ================================================================================
#
# AUTHOR: mjb
# VERSION: 2020101
# MINECRAFT VERSION: 1.0.0
# CREDITS: AtomicStryker (Finder Compass)
# Yoda12999 (Enhanced Compass)
# epinull (original Enhanced Compass)
#
# DESCRIPTION:
# Advanced Compass will find a specified block in a specified range and
# create a colored compass needle pointing
# you to the closest block in that range.
#
# USAGE:
# In this configuration file add a line for the block that you want to search
# for in the following format: (each value should be separated by a colon ':')
#
# blockID:R:G:B:horScan:vertScan:lowLimit:upLimit:scanDelay
# -----------------------------------------------
# blockID = block ID that you want to scan for (see notes)
# R:G:B = color of the needle in hexdecimal format (0 to 255)
# horScan = horizontal scan range / block distance (1 to 128)
# vertScan = vertical scan range / block distance (1 to 128)
# lowLimit = lowest level to scan in (1 to 128)
# upLimit = upper level to scan in (1 to 128)
# scanDelay = how often to run the scan (in seconds)
#
# NOTES:
# Some important information to keep in mind when configuring Advanced Compass.
# - blockID can be found at "http://www.minecraftwiki.net/wiki/Data_values" in
# the "Item IDs" section. Use the "Dec" value.
# - color values can be found at "http://www.colorpicker.com" by choosing your
# color and copy the R G B values respectively.
# - horizontal and vertical scan values / block distance are calculated from the
# 1x1x2 player space. (please see recommendations below!)
# - upper and lower limit is the block range (height / depth) at which the scan
# will only occur. Outside of this range the compass will not show or scan for
# the block ID.
# - scan delay is how often, while in range, the scan will take place
#
# RECOMMENDATIONS:
# While Advanced Compass can track an unlimited number of blocks within
# rendered range you will lock up your computer of you go overboard. The larger
# the horizontal and vertical scan range the more calculations will need to be
# made. The more common the block the more calculations will need to be made.
# The more block IDs that you are tracking the more calculationswill need to be
# made. See a pattern here? Basically only track a few blocks and keep the range
# size and scan delay within reason. See examples for ideas.
#
# When configuring Advanced Compass keep in mind the following.
# - the block ID that you choose should not be too common. e.g. stone (ID 01) is
# not a good idea obviously. Choose only rare blocks.
# - each needle color should be different enough from each other to be easily
# separated visually.
# - horizontal range should be reasonable dependant on the scan delay. Shorter
# scan delays should have smaller horizontal ranges. e.g. with a delay of 1
# second you should keep the horizontal range within 12 to 15 blocks.
# - vertical range should be either 0 (being at the players level) or 1 to scan
# a block level above and below the player. Again, this can be larger if your
# scan delay is longer.
# - when setting your upper and lower scan limits keep in mind that not all
# blocks occur within all depths. e.g. diamond will only occur in the 1 to 16
# block level. Scanning outside of this range is pointless and a waste.
# - the scan delay can greatly affect how many CPU cycles are used. This can
# cause performance issues is set too short with a large scan area for a
# common block. Keep the delay shorter for less common blocks with a shorter
# scan range. A larger delay is acceptable for really rare blocks in a larger
# area. e.g. a dealy of 15 to 20 seconds is recommended for really large scan
# areas for uncommon blocks such as mob spawners or chests at lower levels.
# There is a build in default minimum delay of 1.5 seconds.
#
# EXAMPLES:
# - diamond ore
# 56:0:255:255:15:0:1:16:1
# broken down:
# 56 = the block ID for diamond ore
# 0:255:255 = the RGB for a turquiose color similar to the diamond ore
# 15 = scan 15 blocks out in all direction on the horizontal axis
# 0 = scan only the the same level as the player
# 1:16 = scan only in the depth / range that diamond ore will occur
# 1 = scan for diamond ore every 1 second
#
# - monster spawner
# 52:255:0:0:20:5:1:64:15
# broken down: will scan for a monster spawner block (52) within the levels at
# which they are most common (1 - 64). Will only run the scan every fifeteen (15)
# seconds within a twenty (20) block horizontal plane out from the player and
# five (5) levels above and below the player. If found a red (255:0:0) needle
# will be shown pointing to the monster spanwer block.
#
# ADDITIONAL NOTES:
# If you mess up this file and you receive an error just delete this file and it
# be regenerated.
#
# Please make sure that you know what you are doing if you add your own block IDs.
# Understand the consequneces and how it will affect your computers performance.
# For example scanning for that diamond block example:
# horizontal range of 15 (15 in all directions out from the player or 30 x 30)
# vertical range of 0 (really 2 since it incldes the player)
# so we have: (30 * 30) * 2 = 1800 blocks to scan every second.
#
# scan for the same block with:
# horizontal range of 20 (20 in all directions out from the player or 40 x 40)
# vertical range of 5 (really 5 up and 5 down plus 2 inclding the player or 12)
# so we have: (40 * 40) * (5 + 5 + 2) = 19200 blocks to scan every 15 seconds.
#
# That is a 10x increase in the amount of blocks to process. You can see how a
# small change in just a few of the numbers can affect performance dramatically.
# So stay small to begin with and if you feel that your system can handle more then
# make a small change and restart the game.
#
# [ALL LINES STARTING WITH '#' WILL BE IGNORED!]
#
# PREMADE BLOCK SCANS: (remove the # to activate the needle)
#
# diamond ore [turquiose needle]
56:0:255:255:15:0:1:16:1
#
# gold ore [yellow needle]
# 14:255:255:0:15:0:1:16:1
#
# monster spawner [red needle]
# 52:255:0:0:20:5:1:64:15
#
# possibly an abandoned mine or stronghold by searching for a chest at lower levels
# where a player is less likey to have one [green needle]
# 54:0:255:0:20:5:1:50:15

version 20120101
- supports Minecraft 1.0.0
- separated into individual .zip files to track download usage.

version: 20111012
- Initial release.

name: Advanced Compass 1.8.1
version: 20111012
link: Advanced Compass 1.8.1