Baritone AI pathfinder

This issue is for people to list small documentation problems that they found so that they can all be fixed in one pr.

If you find a documentation issue please comment it here and I will add it to the todo list:

Add an example of using a quantity in mine process

A quick read through Usage.md and a few things I remember

You need to say reset all (not reset) and reset <setting> (not <setting> reset)
To reenable chatControl and prefixControl you should remove one or both lines, not the whole file
Further down the file and also in it's help text #blacklist seems like it affects anything but it's only for GetToBlockProcess (could be seen as a bug/missing feature for MineFrocess and BuilderProcess as well)
We have about 200 settings not about 100
~~Documentation of #eta should mention times being measured in ticks (or we change them to seconds)~~
#axis help says it sets goal to x=0 or z=0; x=z and x=-z and the restriction to y=axisHeight are missing
Documentation of the return value of ToolSet.materialCost omits -1 for non-tools

baritone/src/api/java/baritone/api/Settings.java

Line 243 in dc6b32a

    
                * Syntax same as <a href="https://baritone.leijurv.com/baritone/api/Settings.html#buildSubstitutes">buildSubstitutes</a>

Should be a javadoc link ({@link #buildSubstitutes})

Whilst doing this we should probably also edit some messages such as:

baritone/src/main/java/baritone/pathing/calc/AbstractNodeCostSearch.java

Line 206 in db24a22

System.out.println("But I'm going to do it anyway, because yolo");

This line shouldn't exist

baritone/src/main/java/baritone/utils/GuiClick.java

Line 73 in 23fa65c

///

We should mention that Baritone doesn't support all formats or even list the supported formats here

baritone/src/main/java/baritone/command/defaults/BuildCommand.java

Line 62 in cbef058

    
           throw new CommandInvalidStateException("Couldn't load the schematic. Make sure to use the FULL file name, including the extension (e.g. blah.schematic).");

There's so many people opening bug reports because Baritone outputs this message for .litematic and .nbt

"cannot" is one word

baritone/src/main/java/baritone/command/defaults/FindCommand.java

Line 111 in 4e2095d

    
           "Tab completion will suggest only cached blocks and uncached blocks can not be found.",

can not is valid

this comment is obsolete

baritone/src/main/java/baritone/pathing/movement/movements/MovementTraverse.java

Line 73 in 8b94ac8

    
           return ImmutableSet.of(src, dest); // src.above means that we don't get caught in an infinite loop in water

Settings javadoc should describe the setting, not the default value (it is ok to use the default as an example though). These descriptions currently read as if the setting was a toggle between not using the feature and using it with that one specific value.

baritone/src/api/java/baritone/api/Settings.java

Line 86 in 9350124

* It doesn't actually take twenty ticks to place a block, this cost is so high

baritone/src/api/java/baritone/api/Settings.java

Line 462 in 9350124

* Stop 5 movements before anything that made the path COST_INF.

baritone/src/api/java/baritone/api/Settings.java

Line 812 in 9350124

    
                * If we are more than 300 movements into the current path, discard the oldest segments, as they are no longer useful

baritone/src/api/java/baritone/api/Settings.java

Line 822 in 9350124

* Rescan for the goal once every 5 ticks.

baritone/src/api/java/baritone/api/Settings.java

Line 862 in 9350124

    
                * Take the 10 closest chunks, even if they aren't strictly tied for distance metric from origin.

We should mention what kind of jumps Baritone can currently do.

baritone/src/api/java/baritone/api/Settings.java

Line 310 in 9350124

* You know what it is

This should be removed or turned into debug output

baritone/src/main/java/baritone/process/MineProcess.java

Line 81 in 9350124

System.out.println("Currently have " + curr + " valid items");

This should be "Paste"

baritone/src/main/java/baritone/command/defaults/SelCommand.java

Line 214 in 9350124

    
           baritone.getBuilderProcess().build("Fill", clipboard, pos.add(clipboardOffset));

Share to