Scanner Mod Docs

 New mod: Scanner



It's kinda esp-lite :P but more customisable and with on screen notifications.



4oHbVET.png



The mod is configured by a single console command like

scan [stuff.....]

But the syntax of "stuff" is a bit complex, so instead of drawing BNF diagrams i'll just explain it by a few examples:



Simple mode - just put an outline on something, say me...

scan bdew

That's it, if you have anything with "bdew" in its name - you should see an outline. To turn it off type just "scan" with nothing after it.



Now by default the outline will be in whatever color it is in vanilla (e.g. blue for items, red for enemies, green for village members), if you wanted to give me a pink outline type...

scan bdew @pink

Easy enough. But lets say you also want to find dragons, and you still want me to have a pink outline - just add the dragons after the existing command

scan bdew @pink dragon @yellow

Now anything that has "bdew" in it's name will show up in pink, while everything with "dragon" in it's name will show up in yellow.



But we have a problem, now you are getting highlights for a bunch of people with "dragonslayer" titles, and their "dragoncart 2000" and so on, luckily we can check for models instead

scan bdew @pink %dragons/ @yellow

Using % before a word will make it check the model path instead of the name. You can see the paths of various model by going to your graphics.jar and looking at mappings.txt

And for good measure we can also filter out corpses of dragons, preserved dragons, and dragon pets (from my minipet mod)

scan bdew @pink %dragons/ !corpse !preserved !pet @yellow

Puting a ! before a word will make it filter out anything that matches.

Now say you want to also have a nice big on screen notification every time a dragon is nearby... no problem, just replace the @ with # instead

scan bdew @pink %dragons/ !corpse !preserved !pet #yellow

Now say you also wanted the other uniques too... you could repeat the !corpse... stuff for each but that would be a lot of work, so instead you can use pipe ( | ) before a condition to have do an OR with the previous one

scan bdew @pink %dragons/ |%forestgiant |%trollking |%goblinleader |%creatures/kyklops !corpse !preserved !pet #yellow

And for good measure lets add treasure chests and traitors for missions... and stop making me pink :P

scan %dragons/ |%forestgiant |%trollking |%goblinleader |%creatures/kyklops !corpse !preserved !pet #yellow %treasurechest #pink traitor !corpse !preserved #yellow

New in 1.1 - outline matching

Now you can use & prefix to match color of default outline, so to show only hostile uniques (which would exclude pets, etc.) you can use:

scan %dragons/ |%forestgiant |%trollking |%goblinleader |%creatures/kyklops &hostile #yellow %treasurechest #pink traitor !corpse !preserved #yellow

You could also bind it to a key to turn on and off as you go, for example...

bind ctrl+f1 "scan %dragons/ |%forestgiant |%trollking |%goblinleader |%creatures/kyklops !corpse !preserved !pet #yellow %treasurechest #pink traitor !corpse !preserved #yellow"

bind ctrl+f2 "scan"

This will turn it on when you press Control + F1 and turn it off when you press Control + F2



TLDR

    Word without any special symbols - matches things that have in the name
    % prefix - match against model path instead
    & prefix - match color of default outline (e.g. &hostile to match only hostile creatures)
    ! prefix - negates whatever comes after it
    | prefix - makes an OR condition with the previous one
    @  highlights with outline
    #  highlights with outline + gives on screen notification
    @ and # can be followed by color name or RGB in hex. if no color is given will use default outline color.
    valid colors are:
        red, green, blue, white, black, purple, pink, yellow
        neutral, ally, friend, hostile, gm, dev - default outline colors (will match client settings)
        hex color ( eg "0x00FFFF" for aqua)
    after @ or # the conditions are reset and you can add a new set