Open scorbett123 opened 2 years ago
A quick read through Usage.md and a few things I remember
reset all
(not reset
) and reset <setting>
(not <setting> reset
)chatControl
and prefixControl
you should remove one or both lines, not the whole file#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)#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 missingToolSet.materialCost
omits -1 for non-toolsShould be a javadoc link ({@link #buildSubstitutes}
)
Whilst doing this we should probably also edit some messages such as: https://github.com/cabaletta/baritone/blob/db24a2251fdc615cd43730e046602d95983f29b1/src/main/java/baritone/pathing/calc/AbstractNodeCostSearch.java#L206
We should mention that Baritone doesn't support all formats or even list the supported formats here https://github.com/cabaletta/baritone/blob/cbef05838db84ec77f7a14234b44675a1bc9e5ab/src/main/java/baritone/command/defaults/BuildCommand.java#L62
There's so many people opening bug reports because Baritone outputs this message for .litematic and .nbt
can not is valid
This should be removed or turned into debug output https://github.com/cabaletta/baritone/blob/93501248cd92ae020003e80dc5f89dcaf4a4d4aa/src/main/java/baritone/process/MineProcess.java#L81
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. https://github.com/cabaletta/baritone/blob/93501248cd92ae020003e80dc5f89dcaf4a4d4aa/src/api/java/baritone/api/Settings.java#L86 https://github.com/cabaletta/baritone/blob/93501248cd92ae020003e80dc5f89dcaf4a4d4aa/src/api/java/baritone/api/Settings.java#L462 https://github.com/cabaletta/baritone/blob/93501248cd92ae020003e80dc5f89dcaf4a4d4aa/src/api/java/baritone/api/Settings.java#L812 https://github.com/cabaletta/baritone/blob/93501248cd92ae020003e80dc5f89dcaf4a4d4aa/src/api/java/baritone/api/Settings.java#L822 https://github.com/cabaletta/baritone/blob/93501248cd92ae020003e80dc5f89dcaf4a4d4aa/src/api/java/baritone/api/Settings.java#L862
We should mention what kind of jumps Baritone can currently do. https://github.com/cabaletta/baritone/blob/93501248cd92ae020003e80dc5f89dcaf4a4d4aa/src/api/java/baritone/api/Settings.java#L310
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: