Release v1.4.2 (for 1.20.1) [Fabric/Forge]

Stop supporting 1.19.3 and move on to 1.20.4

Minecraft 1.20.4 is just released and it’s the last version of 1.20. According to poll (on Twitter and Discord) result, the next version of mod (minor version? which means 1.5.0) will skip 1.20.2 and 1.20.3 to compatible with 1.20.4. And we'll stop maintaining 1.19.3 version from now on.

It’s not the final decision yet. If you have something to say about this decision, please speak in mc-general channel in Discord, or post an issue in GitHub, or reply under this tweet.

Bug Fixes

• Fix the bug that ReadCrosshair spam when the player in the fluid and looks at fluid. #222

Mod Version Compatibility

Haven't changed since 1.4.1+1.20.1 (released on 2023 Dec 13).

• Minecraft: 1.20.1 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.84.0+1.20.1 (download Fabric API)
• Forge: 1.20.1-47.2.17 (download Forge installer)
• Architectury API: 9.0.8 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• Fix ReadCrosshair continue to speak when player in the fluid and looks at fluid by @boholder in #223

Full Changelog: v1.4.1-1.20...v1.4.2-1.20

Release v1.4.2 (for 1.19.3) [Fabric/Forge]

Stop supporting 1.19.3 and move on to 1.20.4

Minecraft 1.20.4 is just released and it’s the last version of 1.20. According to poll (on Twitter and Discord) result, the next version of mod (minor version? which means 1.5.0) will skip 1.20.2 and 1.20.3 to compatible with 1.20.4. And we'll stop maintaining 1.19.3 version from now on.

It’s not the final decision yet. If you have something to say about this decision, please speak in mc-general channel in Discord, or post an issue in GitHub, or reply under this tweet.

Bug Fixes

• Fix the bug that ReadCrosshair spam when the player in the fluid and looks at fluid. #222

Mod Version Compatibility

Haven't changed since 1.0.1-beta.2 for 1.19.3 (released on 2023 June 18).

• Minecraft: 1.19.3 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.76.1+1.19.3 (download Fabric API)
• Forge: 1.19.3-44.1.23 (download Forge installer)
• Architectury API: 7.1.86 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• 1.19 fix water spam by @boholder in #224

Full Changelog: v1.4.0-1.19...v1.4.2-1.19

Release v1.4.1 (for 1.20.1) [Fabric/Forge]

Stop supporting 1.19.3 and move on to 1.20.4

Minecraft 1.20.4 is just released and it’s the last version of 1.20. According to poll (on Twitter and Discord) result, the next version of mod (minor version? which means 1.5.0) will skip 1.20.2 and 1.20.3 to compatible with 1.20.4. And we'll stop maintaining 1.19.3 version from now on.

It’s not the final decision yet. If you have something to say about this decision, please speak in mc-general channel in Discord, or post an issue in GitHub, or reply under this tweet.

Bug Fixes

• Fix the bug that can not speak hotbar in latest version of forge (1.20.1-47.2.17) #218

Feature Changes

• Breaking change: config "Speak Action Bar Updates" is renamed to "Speak Action Bar Messages".
• New config "Only Speak Action Bar Updates" for only speak changed part of action bar message when the message is partially updated, useful for some mods like hypixel. #220

Mod Version Compatibility

Forge version upgrade from 47.0.19 to 47.2.17, download it here.

• Minecraft: 1.20.1 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.84.0+1.20.1 (download Fabric API)
• Forge: 1.20.1-47.2.17 (download Forge installer)
• Architectury API: 9.0.8 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• Mainly fix the bug that can not speak hotbar in latest version of forge by @boholder in #219
• Only speak changed action bar by @boholder in #221

Full Changelog: v1.4.0-1.20...v1.4.1-1.20

Release v1.4.0 (for 1.20.1) [Fabric/Forge]

New Features

Speak Text Editing

• Now the mod will simulate the feedback you get when typing text in other software's input boxes, it will speak the text that you delete, select, pass with cursor, on Chat Screen, Book Edit Screen, Command Block Screen and so on.
• Suppress annoying original "speak whole sentence" narration on every text editing operation.
• Simplify the original command suggestion narration for a better typing experience with lesser annoying too-detailed narrations.

See also: description of this feature #187

I18N Fallback Mechanism

A fallback mechanism is added to I18n in case it fails on unsupported languages, or text that not translated in time in supported languages.
If any I18N failed on your language, the mod will use the English version instead.
Set the game to your familiar language is recommended, even if it's not supported by this mod, since you can still be benefited from translatable game original text, such as name of blocks or creatures.
If you want to contribute to translating work, we manage the translation of this mod in another GitHub repository, take a look.

Feature Changes

• Now whenever you're looking at a block and entity, the mod will play a piano sound cue to indicate relative location between you and target. see also: description of this feature #191
• Now the mod will only speak item count when held item type isn't changed (when picking up or spending items), with a new config "Report Held Items Count When Changed", see the configuration.
• Now the mod will speak sitting state of cat, dog, parrot, and so on in Read Crosshair. #192
• Not the mod will speak if an animal is tamed in Read Crosshair.
• Now the mod can tell if a zombie villager is under curing in Read Crosshair. #195
• Now the mod will additionally speak an entity's type if it has a custom name given by the name tag.
• Move "Shearable" word in front of sheep information in Read Crosshair.
• Now the mod will tell if your taming operation is successful or not.
• The default value of config "Disable Speaking Consecutive Blocks With Same Name" in feature Read Crosshair is changed from true to false, to help newcomers understanding the game better.

Bug Fixes

• Fix the bug that keybindings can't be rebound to mouse 4,5 keys (mouse side keys) #190
• Fix the bug that a dead entity can be locked before it disappears. #208

Mod Version Compatibility

Haven't changed since 1.1.0-beta.1 for 1.20.1 (released on 2023 July 2).

• Minecraft: 1.20.1 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.84.0+1.20.1 (download Fabric API)
• Forge: 1.20.1-47.0.19 (download Forge installer)
• Architectury API: 9.0.8 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• Make change log submitting fragmented by @boholder in #174
• (1.20) Update Minecraft Wiki links to new domain by @Spongecade in #181
• [WIP] Area Map - Cursor Reset Key, cursor moving and reset narration by @boholder in #177
• [WIP] Area Map - Vertical and horizontal distance bound by @boholder in #183
• Add introduction of missing chat message feature into manual by @boholder in #196
• Fix the bug that keybindings can't be rebound to mouse 4,5 keys (mouse side keys) by @boholder in #198
• Speak text editing by @boholder in #201
• Crosshair target location cue by @boholder in #206
• Skip locking dead entity by @boholder in #209
• 1.20 improve readcrosshair by @boholder in #211

Full Changelog: v1.3.0-1.20...v1.4.9-1.20

Release v1.4.0 (for 1.19.3) [Fabric/Forge]

New Features

Speak Text Editing

• Now the mod will simulate the feedback you get when typing text in other software's input boxes, it will speak the text that you delete, select, pass with cursor, on Chat Screen, Book Edit Screen, Command Block Screen and so on.
• Suppress annoying original "speak whole sentence" narration on every text editing operation.
• Simplify the original command suggestion narration for a better typing experience with lesser annoying too-detailed narrations.

See also: description of this feature #187

I18N Fallback Mechanism

A fallback mechanism is added to I18n in case it fails on unsupported languages, or text that not translated in time in supported languages.
If any I18N failed on your language, the mod will use the English version instead.
Set the game to your familiar language is recommended, even if it's not supported by this mod, since you can still be benefited from translatable game original text, such as name of blocks or creatures.
If you want to contribute to translating work, we manage the translation of this mod in another GitHub repository, take a look.

Feature Changes

• Now whenever you're looking at a block and entity, the mod will play a piano sound cue to indicate relative location between you and target. see also: description of this feature #191
• Now the mod will only speak item count when held item type isn't changed (when picking up or spending items), with a new config "Report Held Items Count When Changed", see the configuration.
• Now the mod will speak sitting state of cat, dog, parrot, and so on in Read Crosshair. #192
• Not the mod will speak if an animal is tamed in Read Crosshair.
• Now the mod can tell if a zombie villager is under curing in Read Crosshair. #195
• Now the mod will additionally speak an entity's type if it has a custom name given by the name tag.
• Move "Shearable" word in front of sheep information in Read Crosshair.
• Now the mod will tell if your taming operation is successful or not.
• The default value of config "Disable Speaking Consecutive Blocks With Same Name" in feature Read Crosshair is changed from true to false, to help newcomers understanding the game better.

Bug Fixes

• Fix the bug that keybindings can't be rebound to mouse 4,5 keys (mouse side keys) #190
• Fix the bug that a dead entity can be locked before it disappears. #208

Mod Version Compatibility

Haven't changed since 1.0.1-beta.2 for 1.19.3 (released on 2023 June 18).

• Minecraft: 1.19.3 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.76.1+1.19.3 (download Fabric API)
• Forge: 1.19.3-44.1.23 (download Forge installer)
• Architectury API: 7.1.86 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• Make change log submitting fragmented by @boholder in #175
• [1.19] Update Minecraft Wiki links to new domain by @Spongecade in #180
• [WIP] Area Map - Cursor Reset Key, cursor moving and reset narration by @boholder in #178
• [WIP] Area Map - Vertical and horizontal distance bound by @boholder in #184
• Add introduction of missing chat message feature into manual by @boholder in #197
• Fix the bug that keybindings can't be rebound to mouse 4,5 keys (mouse side keys) by @boholder in #199
• Speak text editing by @boholder in #202
• Crosshair target location cue by @boholder in #207

Full Changelog: v1.3.0-1.19...v1.4.0-1.19

Release v1.3.0 (for 1.20.1) [Fabric/Forge]

Feature Changes

• BREAKING CHANGE: Remove left and right mouse simulation keys in Inventory Controls and have the Mouse Simulation feature replace their functions. #168

Bug Fixes

• Fix a bug that PositionNarrator speaks multiple times with single keystroke. #164
• Fix a bug that custom keybindings can not take effect immediately until restart the game. #167
• Fix a bug that all vanilla keys rebinding are invalid. #171
• Fix a bug that POI Entity config can not take effect immediately until restart the game.

Developer Notes

We rewrote the big README into a manual structure for a better readability. Hope this helps you understand and use the mod more easily. As for mouse sim keys removing in Inventory Controls, this change was also made to reduce the confusion for you, since this is a duplication.

Mod Version Compatibility

Haven't changed since 1.1.0-beta.1 for 1.20.1 (released on 2023 July 2).

• Minecraft: 1.20.1 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.84.0+1.20.1 (download Fabric API)
• Forge: 1.20.1-47.0.19 (download Forge installer)
• Architectury API: 9.0.8 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• Fix PositionNarrator speaks multiple times with a light tap by @boholder in #165
• Fix multiple bugs by @boholder in #169
• Rewrite big README into manual structure for better readability by @boholder in #172

Full Changelog: v1.2.2-1.20...v1.3.0-1.20

Release v1.3.0 (for 1.19.3) [Fabric/Forge]

Feature Changes

• BREAKING CHANGE: Remove left and right mouse simulation keys in Inventory Controls and have the Mouse Simulation feature replace their functions. #168

Bug Fixes

• Fix a bug that PositionNarrator speaks multiple times with single keystroke. #164
• Fix a bug that custom keybindings can not take effect immediately until restart the game. #167
• Fix a bug that all vanilla keys rebinding are invalid. #171
• Fix a bug that POI Entity config can not take effect immediately until restart the game.

Developer Notes

We rewrote the big README into a manual structure for a better readability. Hope this helps you understand and use the mod more easily. As for mouse sim keys removing in Inventory Controls, this change was also made to reduce the confusion for you, since this is a duplication.

Mod Version Compatibility

Haven't changed since 1.0.1-beta.2 for 1.19.3 (released on 2023 June 18).

• Minecraft: 1.19.3 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.76.1+1.19.3 (download Fabric API)
• Forge: 1.19.3-44.1.23 (download Forge installer)
• Architectury API: 7.1.86 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• Fix PositionNarrator speaks multiple times with a light tap by @boholder in #166
• Fix multiple bugs and sync branch 1.19 with branch 1.20 by @boholder in #170
• Rewrite big README into manual structure for better readability by @boholder in #173

Full Changelog: v1.2.2-1.19...v1.3.0-1.19

Release v1.2.2 (for 1.20.1) [Fabric/Forge]

Changes and Fixes

• Fix a bug that camera turns straight up and down with double click on Look Up Key and Look Down Key without Right Alt. Now if you hold the Right Alt then keep clicking Look Up Key, the camera will alternately turn to the north or up, same as Right Alt with Look Down Key turning the camera south or down.

Mod Version Compatibility

Haven't changed since 1.1.0-beta.1 for 1.20.1 (released on 2023 July 2).

• Minecraft: 1.20.1 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.84.0+1.20.1 (download Fabric API)
• Forge: 1.20.1-47.0.19 (download Forge installer)
• Architectury API: 9.0.8 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• [WIP] Area Map - Add framework classes by @boholder in #154
• Add change log documentation by @boholder in #155
• Fix camera straight up down without right alt by @boholder in #159
• [WIP] Area Map - Add tests for opening&closing menu, add inner cursor moving by @boholder in #161
• Improve Area Map feature flag, modify build CI by @boholder in #163

Full Changelog: v1.2.1-1.20...v1.2.2-1.20

Release v1.2.2 (for 1.19.3) [Fabric/Forge]

Changes and Fixes

• Fix a bug that camera turns straight up and down with double click on Look Up Key and Look Down Key without Right Alt. Now if you hold the Right Alt then keep clicking Look Up Key, the camera will alternately turn to the north or up, same as Right Alt with Look Down Key turning the camera south or down.

Mod Version Compatibility

Haven't changed since 1.0.1-beta.2 for 1.19.3 (released on 2023 June 18).

• Minecraft: 1.19.3 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.76.1+1.19.3 (download Fabric API)
• Forge: 1.19.3-44.1.23 (download Forge installer)
• Architectury API: 7.1.86 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• Fix camera straight up down without right alt by @boholder in #160
• Modify build CI for new branch names by @boholder in #162

Full Changelog: v1.2.1-1.19...v1.2.2-1.19

Release v1.2.1 (for 1.20.1) [Fabric/Forge]

Changes and Fixes

• Remove "speak different slots with same item content" function in "held item (hotbar) narration", since it will cause the mod to speak in more places it shouldn't, and there is no alternative way to reimplement this function.

Develeoper Notes

Sincere apologies for this bug. Subsequent non-bug-fixing releases will be in beta testing for a week (in form of GitHub's pre-release and Discord's mc-beta-testing channel) before being formally released (in form of GitHub's release and Discord's mc-updates-and-announcements channel). Hope this will narrow the scope of negative impacts caused by newly introduced bugs.

Mod Version Compatibility

Haven't changed since 1.1.0-beta.1 for 1.20.1 (released on 2023 July 2).

• Minecraft: 1.20.1 (read setup guide)
• Fabric Loader: >=0.14.21 (download Fabric Loader)
• Fabric API: 0.84.0+1.20.1 (download Fabric API)
• Forge: 1.20.1-47.0.19 (download Forge installer)
• Architectury API: 9.0.8 (download Architectury API for Fabric or download Architectury API for Forge)

Auto Generated Release Notes

What's Changed

• Revert speak same toSpeak content in different hotbar slots by @boholder in #151

Full Changelog: v1.2.0-1.20...v1.2.1-1.20