Add sound cue playing html

README.md

@@ -20,6 +20,7 @@ Each version of mod will be pre-released on [GitHub](https://github.com/khanshoa
 * [Features](/doc/FEATURES.md)
 * [Keybindings](/doc/KEYBINDINGS.md)
 * [Configuration](/doc/CONFIG.md)
+* [Sound Effects](https://html-preview.github.io/?url=https://github.com/khanshoaib3/minecraft-access/blob/1.20/doc/SOUND.html)
 * [FAQ](/doc/FAQ.md)
 
 ## Useful Links

doc/CHANGELOG.md

@@ -1,3 +1,10 @@
+Release v1.5.4 (2024-03)
+---------------------------
+
+### Refactoring, Documentation and Chores
+
+* Add [Sound Cue Listening Page](/doc/SOUND.html) for making users refer to the sound cue they heard in the game.
+
 Release v1.5.3 (2024-02)
 ---------------------------
 

doc/FEATURES.md

@@ -1,9 +1,12 @@
 # Minecraft Access Features
 
 This page contains details of all the features that are currently in the mod.
+
 If you have any question about original game functions, please search on the [wiki](https://minecraft.wiki/?search) first before asking for help.
 If you have any suggestion on improvements existing features or about a new feature, you can [join the discord server](https://discord.gg/yQjjsDqWQX) or [post an issue](https://github.com/khanshoaib3/minecraft-access/issues).
 
+There is a page for [viewing all sound effects](https://html-preview.github.io/?url=https://github.com/khanshoaib3/minecraft-access/blob/1.20/doc/SOUND.html) used in this mod.
+
 ## Table Of Contents
 
 1. [Camera Controls](#camera-controls)
@@ -109,7 +112,7 @@ See also: [Configuration](/doc/CONFIG.md#inventory-controls), [Keybindings](/doc
 
 ## Point of Interest
 
-This feature will scan and notify (with sound cues) you of (pre-configured) special blocks and all types of entity around you.
+This feature will scan and notify (with sound cues) you of (pre-configured) special blocks and all types of entity around you. You can listen to the sound cues for different types of blocks and entities on the Sound Demo page.
 
 What blocks are considered special? Those you tend to miss.
 In Minecraft, not every block is cube shaped, for example buttons are tiny, single glass block is a thin bar, ladders is a thin layer attached to the wall, you'll find it difficult to point precisely at these blocks.
@@ -118,16 +121,6 @@ Precious blocks like raw ores can be seen at a glance by sighted players, but vi
 By the same token, entities (players, animals, monsters) are movable, so scanning and locking onto them helps you get close to and interact with them.
 Be aware that if you keep any screen opening, the mod will stop scanning and notifying for entities, for a cleaner screen narration, which may get you in danger if there are monsters around you.
 
-| Sound Cue                                                                                    | Description                                                                                                                                                                                    |
-|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Functional blocks without screens (like door, ladder)                                        | ["Bit" (Square wave) of Note Block](https://minecraft.wiki/w/Note_Block#Notes), a beeping electronic sound                                                                                     |
-| Functional blocks that have screens (like crafting table)                                    | [Banjo of Note Block](https://minecraft.wiki/w/Note_Block#Notes), a string instrument sound                                                                                                    |
-| [Ore blocks](https://minecraft.wiki/w/Ore)                                                   | [Item plops](https://minecraft.wiki/w/Item_(entity)#Sounds), bubbling sound, like the sound of pulling out a toilet plunger                                                                    |
-| [Item (entity)](https://minecraft.wiki/w/Item_(entity))                                      | [Pressure Plate clicks](https://minecraft.wiki/w/Pressure_Plate#Unique), crisp clacking sound, like sound of a lighter, or clicking on buttons                                                 |
-| [Passive mobs, Neutral mobs or Players](https://minecraft.wiki/w/Mob?so=search#Passive_mobs) | [Bells (Glockenspiel) of Note Block](https://minecraft.wiki/w/Note_Block#Notes), with the lowest pitch, like the sound of a little bell                                                        |
-| [Hostile mobs](https://minecraft.wiki/w/Mob?so=search#Hostile_mobs)                          | [Bells (Glockenspiel) of Note Block](https://minecraft.wiki/w/Note_Block#Notes) again, with the highest pitch, brief and sharp, like the sound of a time bomb, and you can hear their low roar |
-| Unlocking                                                                                    | [Bass Drum (Kick) of Note Block](https://minecraft.wiki/w/Note_Block#Notes) with the highest pitch, but it's still pretty low                                                                  |
-
 See also: [Configuration](/doc/CONFIG.md#point-of-interest), [Keybindings](/doc/KEYBINDINGS.md#point-of-interest)
 
 ### POI Locking
@@ -153,13 +146,9 @@ See also: [Configuration](/doc/CONFIG.md#entitiesblocks-marking), [Keybindings](
 
 ## Fall Detector
 
-This feature alerts you with a sound cue when you're near the edge of a big drop.
+This feature alerts you with a foot stomping sound cue when you're near the edge of a big drop.
 It will play a sound effect at every location meets the set threshold, the louder the sound, the closer you are to the edge.
 
-| Sound Cue                   | Description                                                                                                               |
-|-----------------------------|---------------------------------------------------------------------------------------------------------------------------|
-| Position with high drop-off | [Breaking the Anvil](https://minecraft.wiki/w/Anvil#Generic), same sound as destroying blocks, like the sound of footstep |
-
 See also: [Configuration](/doc/CONFIG.md#fall-detector)
 
 ## Narrator Menu
@@ -200,15 +189,11 @@ See also: [Configuration](/doc/CONFIG.md#health-n-hunger), [Keybindings](/doc/KE
 
 ### Player Warnings
 
-This feature warns you when your [health](https://minecraft.wiki/w/Health), [hunger](https://minecraft.wiki/w/Hunger) and [air](https://minecraft.wiki/w/Damage#Drowning) (when you're submerged in water) below the set thresholds.
+This feature warns you with the sound of metal when your [health](https://minecraft.wiki/w/Health), [hunger](https://minecraft.wiki/w/Hunger) and [air](https://minecraft.wiki/w/Damage#Drowning) (when you're submerged in water) below the set thresholds.
 You'll hear something like "Warning, Health is {current health}".
 If you enable the `Play Sound` config, you'll also hear a sound cue along with the warning words.
 You may want to learn about [the various damage types](https://minecraft.wiki/w/Damage) in the game.
 
-| Sound Cue                  | Description                                                                  |
-|----------------------------|------------------------------------------------------------------------------|
-| Status reach the threshold | [Anvil landing](https://minecraft.wiki/w/Anvil#Unique), crisp metallic sound |
-
 See also: [Configuration](/doc/CONFIG.md#player-warnings)
 
 ## Book Editing

doc/MOD_COMPATIBILITY.md

@@ -3,7 +3,7 @@ Compatibility For 1.20.4
 
 Haven't changed since [1.5.0+1.20.4](https://github.com/khanshoaib3/minecraft-access/releases/tag/v1.5.0-1.20) (released on 2024 Jan 16).
 
-* Minecraft: 1.20.4 ([read setup guide](https://github.com/khanshoaib3/minecraft-access/blob/default/doc/SET_UP_ON_WINDOWS.md))
+* Minecraft: 1.20.4 ([read setup guide](/doc/SET_UP_ON_WINDOWS.md))
 * Fabric Loader: >=0.15.1 ([download Fabric Loader](https://fabricmc.net/use/installer/))
 * Fabric API: 0.93.1+1.20.4 ([download Fabric API](https://cdn.modrinth.com/data/P7dR8mSH/versions/2sYBLn0C/fabric-api-0.93.1%2B1.20.4.jar))
 * Forge: 1.20.4-49.0.19 ([download Forge installer](https://maven.minecraftforge.net/net/minecraftforge/forge/1.20.4-49.0.19/forge-1.20.4-49.0.19-installer.jar))
@@ -14,7 +14,7 @@ Compatibility For 1.20.1
 
 Haven't changed since [1.4.1+1.20.1](https://github.com/khanshoaib3/minecraft-access/releases/tag/v1.4.1-1.20.1) (released on 2023 Dec 13).
 
-* Minecraft: 1.20.1 ([read setup guide](https://github.com/khanshoaib3/minecraft-access/blob/default/doc/SET_UP_ON_WINDOWS.md))
+* Minecraft: 1.20.1 ([read setup guide](/doc/SET_UP_ON_WINDOWS.md))
 * Fabric Loader: >=0.14.21 ([download Fabric Loader](https://fabricmc.net/use/installer/))
 * Fabric API: 0.84.0+1.20.1 ([download Fabric API](https://cdn.modrinth.com/data/P7dR8mSH/versions/FLGCXPFi/fabric-api-0.84.0%2B1.20.1.jar))
 * Forge: 1.20.1-47.2.17 ([download Forge installer](https://maven.minecraftforge.net/net/minecraftforge/forge/1.20.1-47.2.17/forge-1.20.1-47.2.17-installer.jar))
@@ -25,7 +25,7 @@ Compatibility For 1.19.3
 
 Haven't changed since [1.0.1-beta.2 for 1.19.3](https://github.com/khanshoaib3/minecraft-access/releases/tag/v1.0.1-beta.2) (released on 2023 June 18).
 
-* Minecraft: 1.19.3 ([read setup guide](https://github.com/khanshoaib3/minecraft-access/blob/default/doc/SET_UP_ON_WINDOWS.md))
+* Minecraft: 1.19.3 ([read setup guide](/doc/SET_UP_ON_WINDOWS.md))
 * Fabric Loader: >=0.14.21 ([download Fabric Loader](https://fabricmc.net/use/installer/))
 * Fabric API: 0.76.1+1.19.3 ([download Fabric API](https://cdn.modrinth.com/data/P7dR8mSH/versions/jyKnHEDY/fabric-api-0.76.1%2B1.19.3.jar))
 * Forge: 1.19.3-44.1.23 ([download Forge installer](https://maven.minecraftforge.net/net/minecraftforge/forge/1.19.3-44.1.0/forge-1.19.3-44.1.0-installer.jar))

doc/SOUND.html

@@ -0,0 +1,211 @@
+<html lang="en">
+<head>
+    <title>Sound Effects used in Minecraft Access Mod</title>
+    <!-- Style is mainly copied from -->
+    <!-- https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table -->
+    <style>
+        table {
+            max-width: 800px;
+            border-collapse: collapse;
+            border: 1px solid;
+        }
+
+        th, td {
+            border-collapse: collapse;
+            border: 1px solid;
+            padding: 8px 10px;
+        }
+
+        th {
+            background-color: aliceblue;
+        }
+
+        tr:nth-child(odd) {
+            background-color: #eee;
+        }
+
+        tr:nth-child(even) {
+            background-color: #fff;
+        }
+
+        p {
+            max-width: 800px;
+        }
+    </style>
+</head>
+<body>
+
+<h1>Sound Effects used in Minecraft Access Mod</h1>
+
+<p>
+    This page lists the sound effects used in the Minecraft Access Mod.
+    Sounds are grouped by <a href="FEATURES.md">mod feature name</a> that they are used in.
+    You can play them by clicking the player.
+</p>
+
+<h2>Features</h2>
+
+<h3 id="read-crosshair">Read Crosshair</h3>
+
+<table>
+    <thead>
+    <tr>
+        <th>Description</th>
+        <th>Sound</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+        <td>
+            When you're looking at a block and an entity, the mod will play a sound cue to indicate the relative location between you and the target.
+            Volume to represent distance, the louder the sound the closer the distance.
+            Pitch to represent altitude, the higher the pitch the higher the target is relative to you.
+            You can turn off this feature or change sound volume in config.
+        </td>
+        <td>
+            piano sound
+            <audio preload="none" controls src="sounds/Note_block_harp_scale.ogg"></audio>
+        </td>
+    </tr>
+    </tbody>
+</table>
+
+<h3 id="point-of-interest">Point of Interest</h3>
+
+<table>
+    <thead>
+    <tr>
+        <th>Description</th>
+        <th>Sound</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+        <td>Position of functional blocks without screens (like <a href="https://minecraft.wiki/w/Door">Door</a>,<a href="https://minecraft.wiki/w/Ladder">Ladder</a>)</td>
+        <td>
+            Beeping electronic sound
+            <audio preload="none" controls src="sounds/Note_block_bit_pitch2.ogg"></audio>
+        </td>
+    </tr>
+    <tr>
+        <td>Position of functional blocks that have screens (like <a href="https://minecraft.wiki/w/Crafting_table">Crafting Table</a>)</td>
+        <td>
+            String sound
+            <audio preload="none" controls src="sounds/Note_block_banjo_pitch0.ogg"></audio>
+        </td>
+    </tr>
+    <tr>
+        <td>Position of <a href="https://minecraft.wiki/w/Ore">Ore blocks</a></td>
+        <td>
+            Bubbling sound
+            <audio preload="none" controls src="sounds/Pop.ogg"></audio>
+        </td>
+    </tr>
+    <tr>
+        <td>Position of <a href="https://minecraft.wiki/w/Item_(entity)">Dropped Item</a></td>
+        <td>
+            Click sound
+            <audio preload="none" controls src="sounds/Click.ogg"></audio>
+        </td>
+    </tr>
+    <tr>
+        <td>Position of <a href="https://minecraft.wiki/w/Mob?so=search#Passive_mobs">Passive mobs (Animals)</a>, Neutral mobs and Players</td>
+        <td>
+            Bell sound at low pitch
+            <audio preload="none" controls src="sounds/Note_block_bell_pitch0.ogg"></audio>
+        </td>
+    </tr>
+    <tr>
+        <td>Position of <a href="https://minecraft.wiki/w/Mob?so=search#Hostile_mobs">Hostile mobs (Monsters)</a></td>
+        <td>
+            Bell sound at high pitch
+            <audio preload="none" controls src="sounds/Note_block_bell_pitch2.ogg"></audio>
+        </td>
+    </tr>
+    <tr>
+        <td>Unlocking action in POI Locking feature</td>
+        <td>
+            Drum sound
+            <audio preload="none" controls src="sounds/Note_block_bass_drum_pitch2.ogg"></audio>
+        </td>
+    </tr>
+    </tbody>
+</table>
+
+<h3 id="fall-detector">Fall Detector</h3>
+
+<table>
+    <thead>
+    <tr>
+        <th>Description</th>
+        <th>Sound</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+        <td>Position with high drop-off</td>
+        <td>
+            Foot stamping sound (which is actually the sound of a stone block breaking)
+            <audio preload="none" controls src="sounds/Stone_dig1.ogg"></audio>
+        </td>
+    </tr>
+    </tbody>
+</table>
+
+<h3 id="player-warnings">Player Warnings</h3>
+
+<table>
+    <thead>
+    <tr>
+        <th>Description</th>
+        <th>Sound</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+        <td>
+            [Health](https://minecraft.wiki/w/Health),
+            [hunger](https://minecraft.wiki/w/Hunger) or
+            [air](https://minecraft.wiki/w/Damage#Drowning)
+            status reach the configured danger warning threshold
+        </td>
+        <td>
+            Metal sound (the sound of an anvil landing on the ground)
+            <audio preload="none" controls src="sounds/Anvil_land.ogg"></audio>
+        </td>
+    </tr>
+    </tbody>
+</table>
+
+<h2>Disclaimer</h2>
+
+<p>
+    <b>Disclaimer:</b>
+    Most of the sounds are original to the game and copyrighted by the owner of <a href="https://www.minecraft.net/">Minecraft</a>.
+    Some sounds are downloaded from free sound effect sharing sites, We'll list them with their sources below.
+    Some sound files listed on this page are taken from <a href="https://minecraft.wiki/">minecraft.wiki</a>
+    and therefore licensed under <a href="https://creativecommons.org/licenses/by-nc-sa/3.0/">CC BY-NC-SA 3.0</a>.
+</p>
+
+<h2>Third Party Sound Files</h2>
+
+<p>Thanks to the following sound authors for bringing this mod to life:</p>
+
+<table class="third-party-sounds">
+    <thead>
+    <tr>
+        <th>Sound File Name</th>
+        <th>Author</th>
+        <th>Source Link</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+        <td></td>
+        <td></td>
+        <td></td>
+    </tr>
+    </tbody>
+</table>
+</body>
+</html>