mod-sounds/README.md
2021-08-08 20:44:04 -07:00

202 lines
12 KiB
Markdown

## Sound Pack for Minetest
### Description:
A [Minetest][] mod that provides a set of free sounds & methods. It is intended as a more universal method for adding sounds to games than depending on [MTG & default][default] for sounds only.
As of right now, only sounds from *default* mod have been added.
<img src="screenshot.png" alt="icon" width="200" />
### Licensing:
- Code: [MIT](LICENSE.txt)
- Icon/Screenshot: [CC0](https://openclipart.org/detail/260975)
- Media: see following table
#### Sound file sources & licensing:
##### General Sounds:
| Filename (sounds_) / Source | Author | License | Notes |
| --------------------------------- | ------------------------ | ------------ | ----------------------- |
| [apple_bite][] | sonicmariobrotha | CC0 | |
| [bird*][bird] | Jc Guan | CC0 | |
| [boing][] | reelworldstudio | CC0 | |
| [cat_meow][] | blimp66 | CC BY 3.0 | |
| [clock_tick][] | AntumDeluge | CC0 | |
| [coin][] | greenvwbeetle | CC0 | |
| [cow_moo*][cow_moo] | JosephSardin | CC0 | |
| [dog_bark][] | ivolipa | CC0 | |
| [elephant][] | vataaa | CC0 | |
| [entity_hit][] | sonictechtonic | CC BY 3.0 | |
| [explosion][] | JuveriSetila | CC0 | |
| [frog][] | kayceemixer | CC0 | |
| [fuse][] | Ned Bouhalassa | CC0 | |
| [gallop_01][] | Alan McKinney (alanmcki) | CC BY 3.0 | |
| [gallop_02][] | Alan McKinney (alanmcki) | CC BY 3.0 | |
| [grasshopper][] | straget | CC0 | |
| [horse_neigh_01][] | GoodListener | CC BY 3.0 | |
| [horse_neigh_02][] | foxen10 | CC0 | |
| [horse_snort_01][] | madklown | CC0 | |
| [horse_snort_02][] | 0_ciz | CC0 | |
| [jaguar_saw][] | About Zoos | CC BY | |
| [lion_bellow][] | felix.blume | CC0 | |
| [mouse][] | AntumDeluge | CC0 | |
| [owl_hoot][] | Anthousai | CC0 | |
| [pencil_erase][] | damsur | CC0 | |
| [pencil_write][] | NachtmahrTV | CC0 | |
| [quail][] | PrincessGrace | CC0 | |
| [rooster][] | poorenglishjuggler | CC0 | |
| [sheep][] | mikewest | CC0 | |
| [skeleton_bones][] | AntumDeluge | CC0 | |
| [tiger_roar_01][] | videog | CC BY 3.0 | |
| [tiger_snarl_01][tiger_roar_01] | videog | CC BY 3.0 | |
| [tiger_snarl_[02-04][tiger_snarl] | schots | CC0 | |
| [vulture][] | AntumDeluge | CC0 | |
| [watch_tick][] | Nicolas4677 | CC0 | |
| [whistle][] | pawsound | CC0 | |
| [yak][] | AntumDeluge | CC0 | |
| [zebra][] | Peet J van Eeden | CC BY | |
##### Node Sounds:
| Filename (sounds_node_) / Source | Author | License | Notes |
| --------------------------------- | ------------------------ | ------------ | ----------------------- |
| [dig_choppy.*][dig_choppy] | Sheyvan | CC0 | |
| [dig_cracky.*][dig_cracky] | Benboncan | CC BY 3.0 | |
| [dig_crumbly][default] | Mito551 | CC BY-SA 3.0 | |
| [dig_gravel.*][gravel_dig] | lolamadeus | CC0 | |
| [dig_ice.*][dig_ice] | dheming | CC BY 3.0 | |
| [dig_metal][] | yadronoff | CC BY 3.0 | |
| [dig_snappy][] | blukotek | CC0 | |
| [dug.*][default] | Mito551 | CC BY-SA 3.0 | |
| [dug_glass.1][] | cmusounddesign | CC BY 3.0 | |
| [dug_glass.2][] | Tomlija | CC BY 3.0 | |
| [dug_glass.3][] | lsprice | CC BY 3.0 | |
| [dug_gravel.*][gravel_dig] | lolamadeus | CC0 | |
| [dug_ice][] | Angel_Perez_Grandi | CC BY 3.0 | |
| [dug_metal.*][dug_metal] | qubodup | CC0 | |
| [place*][default] | Mito551 | CC BY-SA 3.0 | |
| [place_metal.*][place_metal] | Ogrebane | CC0 | |
| [step_dirt.*][default] | Mito551 | CC BY-SA 3.0 | |
| [step_glass][default] | Mito551 | CC BY-SA 3.0 | |
| [step_grass.*][default] | Mito551 | CC BY-SA 3.0 | |
| [step_gravel][default] | Mito551 | CC BY-SA 3.0 | |
| [step_hard.*][step_hard] | Erdie | CC BY 3.0 | |
| [step_ice.*][ice] | InspectorJ | CC BY 3.0 | |
| [step_metal.*][metal] | mypantsfelldown | CC0 | |
| [step_sand.*][sand] | worthahep88 | CC0 | |
| [step_snow.*][snow] | Ryding | CC0 | |
| [step_water.1][] | AGFX | CC BY 3.0 | |
| [step_water.2][] | AGFX | CC BY 3.0 | |
| [step_water.3][] | AGFX | CC BY 3.0 | |
| step_water.4 | AntumDeluge | CC0 | generated with Audacity |
| [step_wood.*][default] | Mito551 | CC BY-SA 3.0 | |
### Usage:
If your mod depends on *default* for node sounds only, then you can easily switch to *sounds*. Simply add *default* & *sounds* as optional dependencies in your *mod.conf*. *sounds* aliases or overrides methods used by *default* to its own. For example *default.node_sound_dirt_defaults*.
Example code:
```lua
function sounds.node_dirt(tbl)
tbl = tbl or {}
tbl.footstep = tbl.footstep or {name="sounds_dirt_step", gain=0.4}
tbl.dug = tbl.dug or {name="sounds_dirt_step", gain=1.0}
tbl.place = tbl.place or {name="sounds_node_place_soft", gain=1.0}
sounds.node(tbl)
return tbl
end
default.node_sound_dirt_defaults = sounds.node_dirt
```
Playing sounds manually:
```lua
-- play random sound from group
sounds.horse_neigh()
-- play specific sound from group
sounds.harse_neigh(2)
-- play random sound from group with parameters
sounds.horse_neigh({gain=1.0})
-- play specific sound from group with parameters
sounds.horse_neigh(2, {gain=1.0})
```
### Links:
- [![ContentDB](https://content.minetest.net/packages/AntumDeluge/sounds/shields/title/)](https://content.minetest.net/packages/AntumDeluge/sounds/)
- [Forum](https://forum.minetest.net/viewtopic.php?t=26868)
- [Git repo](https://github.com/AntumMT/mod-sounds)
- [API](https://antummt.github.io/mod-sounds/reference/)
- [Changelog](changelog.txt)
- [TODO](TODO.txt)
[Minetest]: http://minetest.net/
[default]: https://github.com/minetest/minetest_game/tree/master/mods/default
[apple_bite]: https://freesound.org/s/333825/
[bird]: https://soundbible.com/340-Bird-Song.html
[boing]: https://freesound.org/s/161122/
[cat_meow]: https://freesound.org/s/397661/
[clock_tick]: https://opengameart.org/node/16323
[coin]: https://freesound.org/s/423332/
[cow_moo]: https://freesound.org/s/177253/
[dig_choppy]: https://freesound.org/s/476113/
[dig_cracky]: https://freesound.org/s/71823/
[dig_gravel]: https://freesound.org/s/179341/
[dig_ice]: https://freesound.org/s/268023/
[dig_metal]: https://freesound.org/s/320397/
[dig_snappy]: https://freesound.org/s/251660/
[dog_bark]: https://freesound.org/s/328730/
[dug_glass.1]: https://freesound.org/s/71947/
[dug_glass.2]: https://freesound.org/s/97669/
[dug_glass.3]: https://freesound.org/s/88808/
[dug_ice]: https://freesound.org/s/49190/
[dug_metal]: https://opengameart.org/node/18150
[elephant]: https://freesound.org/s/148873/
[entity_hit]: https://freesound.org/s/241872/
[explosion]: https://freesound.org/s/514133/
[frog]: https://freesound.org/s/251495/
[fuse]: https://freesound.org/s/8320/
[gallop_01]: https://freesound.org/s/403026/
[gallop_02]: https://freesound.org/s/403025/
[grasshopper]: https://freesound.org/s/401939/
[horse_neigh_01]: https://freesound.org/s/322443/
[horse_neigh_02]: https://freesound.org/s/149024/
[horse_snort_01]: https://freesound.org/s/184503/
[horse_snort_02]: https://freesound.org/s/475480/
[jaguar_saw]: https://www.youtube.com/watch?v=VJ0RCZXu0v4
[lion_bellow]: https://freesound.org/s/405211/
[mouse]: https://opengameart.org/node/16331
[owl_hoot]: https://freesound.org/s/398734/
[pencil_erase]: https://freesound.org/s/443241/
[pencil_write]: https://freesound.org/s/571800/
[place_metal]: https://opengameart.org/node/3511
[quail]: https://freesound.org/s/329371/
[rooster]: https://freesound.org/s/269496/
[step_hard]: https://freesound.org/s/41579/
[step_ice]: https://freesound.org/s/416967/
[step_metal]: https://freesound.org/s/398937/
[step_sand]: https://freesound.org/s/319224/
[step_snow]: https://freesound.org/s/94337/
[step_water.1]: https://freesound.org/s/20432/
[step_water.2]: https://freesound.org/s/20434/
[step_water.3]: https://freesound.org/s/20437/
[sheep]: https://freesound.org/s/414342/
[skeleton_bones]: https://opengameart.org/node/16324
[tiger_roar_01]: https://freesound.org/s/149190/
[tiger_snarl]: https://freesound.org/s/439280/
[vulture]: https://opengameart.org/node/16329
[watch_tick]: https://freesound.org/s/446611/
[whistle]: https://freesound.org/s/154873/
[yak]: https://opengameart.org/node/98682
[zebra]: https://www.youtube.com/watch?v=xjGJ_XMVTRE