mtcontrib/xcompat
1
0
Fork 0
mirror of https://github.com/mt-mods/xcompat.git synced 2024-12-22 17:10:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

improve/split readme per sx suggestions

Browse Source
This commit is contained in:
unknown 2022-05-01 20:17:46 -04:00
parent e0e21f9a6c
commit 42d876fa75
2 changed files with 62 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
DEV.md Normal file
View File

@ -0,0 +1,50 @@
# Sound API
This mod is a wrapper for [sound api library](https://github.com/mt-mods/sound_api_core/).
## Usage of the sound api
### Option 1: embed
You can insert the [sound api library](https://github.com/mt-mods/sound_api_core/) directly into your mod as a submodule and use the following to load it.
```lua
local sound_api = dofile(modpath .. "/sound_api_core/init.lua")
```
additionally the author recommends that you use dependabot(github) or similar to help you keep the submodule up to date.
### Option 2: Agnostically depend
You can do this by using a custom field in your node def instead of the `sounds` key.
```lua
minetest.register_node(nodename, {
...
_sound_def = {
key = "",
input = {},
},
...
})
```
where:
* key: string name of the field from the sound api you want to use, for example `node_sound_stone_defaults`
* input: table input of fields you want passed to the key field, used to override specific sounds.
### Option 3: Hard depend
add this mod to your mod.confs depends and directly call the sound_api as follows
```lua
minetest.register_node(nodename, {
...
sounds = sound_api.node_sound_stone_defaults(input)
...
})
```
* input: optional table to override some or all of returned values

55
README.md
View File

@ -1,50 +1,19 @@
# Sound API
This mod is a wrapper for [sound api library](https://github.com/mt-mods/sound_api_core/).
mod that enables sound to be game agnostic
## Installing
## Usage of the sound api
* `git clone https://github.com/mt-mods/sound_api.git`
* `cd sound_api`
* `git submodule init`
* `git submodule update`
### Option 1: embed
to update please use the following commands starting inside the mod directory
You can insert the [sound api library](https://github.com/mt-mods/sound_api_core/) directly into your mod as a submodule and use the following to load it.
* `git pull`
* `git submodule sync`
* `git submodule update`
```lua
local sound_api = dofile(modpath .. "/sound_api_core/init.lua")
```
additionally the author recommends that you use dependabot(github) or similar to help you keep the submodule up to date.
### Option 2: Agnostically depend
You can do this by using a custom field in your node def instead of the `sounds` key.
```lua
minetest.register_node(nodename, {
...
_sound_def = {
key = "",
input = {},
},
...
})
```
where:
* key: string name of the field from the sound api you want to use, for example `node_sound_stone_defaults`
* input: table input of fields you want passed to the key field, used to override specific sounds.
### Option 3: Hard depend
add this mod to your mod.confs depends and directly call the sound_api as follows
```lua
minetest.register_node(nodename, {
...
sounds = sound_api.node_sound_stone_defaults(input)
...
})
```
* input: optional table to override some or all of returned values
## Dev Docs
Can be found at /DEV.md