baritone
baritone copied to clipboard
Small documentation issues
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(notreset) andreset <setting>(not<setting> reset) - To reenable
chatControlandprefixControlyou should remove one or both lines, not the whole file - Further down the file and also in it's help text
#blacklistseems like it affects anything but it's only forGetToBlockProcess(could be seen as a bug/missing feature forMineFrocessandBuilderProcessas well) - We have about 200 settings not about 100
- ~Documentation of
#etashould mention times being measured in ticks (or we change them to seconds)~ #axishelp says it sets goal to x=0 or z=0; x=z and x=-z and the restriction to y=axisHeightare missing- Documentation of the return value of
ToolSet.materialCostomits -1 for non-tools
https://github.com/cabaletta/baritone/blob/dc6b32a154c7c92e9a1ea5a5ebbd40fd782d08c5/src/api/java/baritone/api/Settings.java#L243
Should 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
This line shouldn't exist https://github.com/cabaletta/baritone/blob/23fa65cee003ab34e7f8d4576295b9c88570f5d8/src/main/java/baritone/utils/GuiClick.java#L73
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
"cannot" is one word https://github.com/cabaletta/baritone/blob/4e2095d25114dd88fa01baf21a805d3f6e1b8ee9/src/main/java/baritone/command/defaults/FindCommand.java#L111
can not is valid
this comment is obsolete https://github.com/cabaletta/baritone/blob/8b94ac8fca5cd4fced38dd4dfea6f04b3ce722d7/src/main/java/baritone/pathing/movement/movements/MovementTraverse.java#L73
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 should be "Paste" https://github.com/cabaletta/baritone/blob/93501248cd92ae020003e80dc5f89dcaf4a4d4aa/src/main/java/baritone/command/defaults/SelCommand.java#L214