0 |
<?xml version="1.0" encoding="UTF-8" ?> |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
2 |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
3 |
|
4 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
5 |
|
6 |
<head> |
7 |
<title>README.html</title> |
8 |
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/> |
9 |
|
10 |
</head> |
11 |
|
12 |
<body> |
13 |
|
14 |
<h1>Subtitles</h1> |
15 |
<p><a href="https://content.minetest.net/packages/SilverSandstone/subtitles/">ContentDB</a></p> |
16 |
<p>This mod adds multiple styles of on-screen subtitles for sound effects.</p> |
17 |
<p>Subtitles are disabled by default in multiplayer, and can be enabled and configured for each player. |
18 |
You can access your subtitle preferences by clicking the <img alt="Subtitles icon" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAgMAAABinRfyAAAACVBMVEUAAAAAAAD///+D3c/SAAAAAXRSTlMAQObYZgAAAC5JREFUCFtjYEAFrKGhAQxSq1YtQSckp6WmQFmR06As1tDMAKCeFJBGEIPBgQEAwEwSV24kTgQAAAAASUVORK5CYII=" title="Subtitles" /> button in the inventory or by typing <code>/subtitles</code> in chat.</p> |
19 |
<h2>Supported Games and Mods</h2> |
20 |
<p>Descriptions are provided for these games:</p> |
21 |
<ul> |
22 |
<li>Minetest Game</li> |
23 |
<li>MineClone</li> |
24 |
<li>NodeCore</li> |
25 |
<li>Repixture</li> |
26 |
<li>Jail Escape</li> |
27 |
<li>Builda City</li> |
28 |
<li>Alter</li> |
29 |
<li>Moontest</li> |
30 |
<li>Super Sam</li> |
31 |
<li>Subway Miner</li> |
32 |
</ul> |
33 |
<p>Descriptions are provided for these mods:</p> |
34 |
<ul> |
35 |
<li>Advanced Trains<ul> |
36 |
<li>Basic Trains</li> |
37 |
<li>More Trains</li> |
38 |
<li>DlxTrains</li> |
39 |
<li>Trains are Neat</li> |
40 |
<li>Advanced Trains Freight Train</li> |
41 |
<li>JR E231</li> |
42 |
</ul> |
43 |
</li> |
44 |
<li>Ambience</li> |
45 |
<li>Animalia<ul> |
46 |
<li>Creatura</li> |
47 |
</ul> |
48 |
</li> |
49 |
<li>Anvil</li> |
50 |
<li>APercy's aeroplanes<ul> |
51 |
<li>Demoiselle</li> |
52 |
<li>Ju52</li> |
53 |
<li>PA28</li> |
54 |
<li>Super Cub</li> |
55 |
<li>Super Duck Hydroplane</li> |
56 |
<li>Ultralight Trike</li> |
57 |
</ul> |
58 |
</li> |
59 |
<li>Automobiles Pack</li> |
60 |
<li>Awards</li> |
61 |
<li>Bedrock</li> |
62 |
<li>Bees</li> |
63 |
<li>Bell</li> |
64 |
<li>Bows</li> |
65 |
<li>BWeapons Modpack</li> |
66 |
<li>Castle Weapons</li> |
67 |
<li>Death Compass</li> |
68 |
<li>DFCaverns</li> |
69 |
<li>Digtron</li> |
70 |
<li>Documentation System</li> |
71 |
<li>Draconis</li> |
72 |
<li>CCompass</li> |
73 |
<li>Enderpearl</li> |
74 |
<li>Fishing!</li> |
75 |
<li>Gunslinger</li> |
76 |
<li>Home Decor</li> |
77 |
<li>Hudbars</li> |
78 |
<li>i3</li> |
79 |
<li>Mesebox</li> |
80 |
<li>Mesecons</li> |
81 |
<li>Mese Portals</li> |
82 |
<li>Minetest Game Plus</li> |
83 |
<li>Mobs<ul> |
84 |
<li>Mobs Animal</li> |
85 |
<li>Mobs Monster</li> |
86 |
<li>Mobs Creature</li> |
87 |
<li>Mobs Skeleton</li> |
88 |
<li>Mobs MC</li> |
89 |
<li>Mob Horse</li> |
90 |
<li>Extra Mobs</li> |
91 |
</ul> |
92 |
</li> |
93 |
<li>Nether</li> |
94 |
<li>New Fireworks</li> |
95 |
<li>NextGen Bows</li> |
96 |
<li>Pedology</li> |
97 |
<li>Pyramids</li> |
98 |
<li>Radiant Damage</li> |
99 |
<li>Real Torch</li> |
100 |
<li>Regional Weather</li> |
101 |
<li>Ropes</li> |
102 |
<li>Scythes and Sickles</li> |
103 |
<li>Shifter Tool</li> |
104 |
<li>Sounds</li> |
105 |
<li>Spyglass</li> |
106 |
<li>Stamina</li> |
107 |
<li>Steampunk Blimp</li> |
108 |
<li>Storage Drawers</li> |
109 |
<li>Torch Bomb</li> |
110 |
<li>Travelnet</li> |
111 |
<li>Unified Inventory</li> |
112 |
<li>Vacuum</li> |
113 |
<li>Vehicles</li> |
114 |
<li>Weather</li> |
115 |
<li>X Clay</li> |
116 |
<li>X Enchanting</li> |
117 |
</ul> |
118 |
<p>UI integration is provided for these games and mods:</p> |
119 |
<ul> |
120 |
<li>Simple Fast Inventory (via SFInv Buttons)</li> |
121 |
<li>Unified Inventory</li> |
122 |
<li>i3</li> |
123 |
<li>Repixture</li> |
124 |
</ul> |
125 |
<h2>Supporting Subtitles in Your Mod</h2> |
126 |
<p>There are two ways a mod can support subtitles.</p> |
127 |
<p>You can associate a description with a sound name using |
128 |
<code>subtitles.register_description(sound_name, description)</code>:</p> |
129 |
<pre><code>subtitles.register_description('default_dig_metal', S'Metal clangs'); |
130 |
</code></pre> |
131 |
<p>Alternatively, you can specify a description by setting <code>description</code> or |
132 |
<code>subtitle</code> in either the sound spec or the parameters when playing a sound:</p> |
133 |
<pre><code>minetest.sound_play('default_dig_metal', {gain = 0.5, description = S'Hitting metal'}); |
134 |
minetest.sound_play({name = 'default_dig_metal', description = S'Hitting metal'}, {gain = 0.5}); |
135 |
</code></pre> |
136 |
<p>This also works in node definitions:</p> |
137 |
<pre><code>minetest.register_node('foomod:foobarium', |
138 |
{ |
139 |
description = S'Foobarium'; |
140 |
sounds = |
141 |
{ |
142 |
dig = {name = 'default_dig_metal', description = S'Foobarium breaks'}; |
143 |
footstep = {name = 'default_dig_metal', description = S'Footstep on foobarium'}; |
144 |
}; |
145 |
}); |
146 |
</code></pre> |
147 |
<p>You can specify how long to display the subtitle by setting <code>duration</code> on |
148 |
either the spec or the parameters.</p> |
149 |
<p>You can disable the subtitle for a sound by setting <code>no_subtitle = true</code> on |
150 |
the spec or parameters, or by setting the description to an empty string.</p> |
151 |
<h2>License</h2> |
152 |
<p>Copyright © 2022‒2023, Silver Sandstone <a href="mailto:@SilverSandstone@craftodon.social">@SilverSandstone@craftodon.social</a><br /> |
153 |
Licensed under the MIT license, with assets under CC0.</p> |
154 |
<p>See <code>LICENSE.md</code> for more information.</p> |
155 |
</body> |
156 |
</html> |