Better-Sprinting/TESTING.md

Complete test procedure

1. Controls Menu

1. Click [Options] -> [Controls]
2. • ✔ [Better Sprinting] button appears in place of [Auto-Jump] button
3. • ✔ [Sprint] keybinding is removed
4. Click [Better Sprinting]
5. • ✔ All option buttons and labels are aligned properly
6. • ✔ All option buttons have a tooltip
7. Click [Disable mod]
8. • ✔ All other option buttons except for [Sprint], [Mod configuration], [Auto-jump] become disabled

2. In-game Vanilla

1. Transformer
2. • ✔ Print out transformed instructions and ensure they make sense
3. • ✔ Do a cursory check in-game with the mod disabled
4. Press the [Sprint menu] key
5. • ✔ Ensure clicking [Controls] and then [Done] returns to the sprint menu
6. Click [Disable mod] again to re-enable the mod

3. In-game Custom

1. Single key bindings
2. • ✔ Sprint (tap & hold)
3. • ✔ Sprint (toggle)
4. • ✔ Sneak (toggle)
5. • ✔ Ensure modifier combos work as expected
6. Combined key bindings
7. • ✔ While sprinting, hold sneak (hold) key to sneak, release to resume sprint
8. • ✔ While sprinting, press sneak (toggle) key to sneak, press again to resume sprint
9. • ✔ While sprinting after tapping or toggling, press the sprint key to stop sprinting
10. • ✔ While toggle sneaking, press the sneak key to stop sneaking
11. • ✔ While sneaking, both forms of sprinting are blocked
12. Ensure remaining options behave as expected
13. • ✔ Double tapping
14. • ✔ Run in all directions
15. • ✔ Fly boost
16. • ✔ Fly on ground
17. • ✔ Auto-jump
18. Test special interactions
19. • ✔ While toggle sneaking, open chat/inventory/pause menu to stop sneaking, close menu to resume sneaking
20. • ✔ While submerged in water, all forms of sprinting trigger swimming
21. Run /effect give @p minecraft:blindness 5 0
22. • ✔ Ensure sprinting is blocked
23. Run /effect give @p minecraft:hunger 10 255
24. • ✔ Ensure sprinting stops once hunger drops too low

4. Modded Client + Modded Server

1. Install the mod on client and server, and connect
2. • ✔ Ensure /bettersprinting is only available to operators
3. • ✔ The mod works and sprinting in all directions is disabled
4. Run /bettersprinting setting runInAllDirs true
5. • ✔ Sprinting in all directions can now be controlled in sprint menu
6. • ✔ Restarting the server remembers the setting
7. Run /bettersprinting setting runInAllDirs false
8. • ✔ Sprinting in all directions no longer works
9. Run /bettersprinting disablemod true
10. • ✔ Client receives a notification message
11. • ✔ Vanilla mechanics are forced as if [Disable mod] was enabled
12. • ✔ Logging out and back in displays the message and keeps vanilla mechanics
13. • ✔ Restarting the server remembers the setting
14. Switch to a supported language other than English
15. Run /bettersprinting disablemod false
16. • ✔ Client receives a notification message (in the selected language)
17. • ✔ Modded mechanics are restored
18. Manually turn on [Disable mod]
19. • ✔ Running the disablemod commands again does not show a notification message

5. Modded Client + Vanilla Server

1. Run vanilla server, and connect
2. • ✔ The mod works and sprinting in all directions is disabled

6. Vanilla Client + Modded Server

1. Run modded server, switch to vanilla client, and connect
2. Run /bettersprinting disablemod true
3. • ✔ Client does not receive a notification message
4. • ✔ Command response is displayed in English