diff --git a/.cdb.json b/.cdb.json index 8e256a7..36f388e 100644 --- a/.cdb.json +++ b/.cdb.json @@ -7,5 +7,5 @@ "repo": "https://github.com/fluxionary/minetest-toolcap_monoids.git", "website": "https://github.com/fluxionary/minetest-toolcap_monoids", "issue_tracker": "https://github.com/fluxionary/minetest-toolcap_monoids/issues", - "short_description": "TODO: write a description" + "short_description": "an API to allow multiple sources to apply changes to a tools's capabilities." } diff --git a/README.md b/README.md index 6605d01..ee85fb3 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ # toolcap_monoids -some standard tool_monoids. +an API to allow multiple sources to apply changes to a tools's capabilities. -* `toolcap_monoids.full_punch` +### `toolcap_monoids.full_punch` modifies the "full punch" interval. multiplicative. values > 1 will increase time between full punches, < 1 will decrease the same. -* `toolcap_monoids.dig_speed` +### `toolcap_monoids.dig_speed` modifies dig times. multiplicative. values > 1 will increase dig time, < 1 will decrease dig time. values can also be tables mapping specific groupcaps to specific multipliers. -* `toolcap_monoids.durability` +### `toolcap_monoids.durability` modifies tool uses. multiplicative. values > 1 will increase durability, < 1 will decrease durability. values can also be tables mapping specific groupcaps to specific multipliers. -* `toolcap_monoids.damage` +### `toolcap_monoids.damage` modifies tool damage groups. *additive*, not multiplicative. values must be tables mapping damage groups to the increase (or decrease) in damage for that group. diff --git a/mod.conf b/mod.conf index aeda14e..e6199a6 100644 --- a/mod.conf +++ b/mod.conf @@ -1,6 +1,6 @@ name = toolcap_monoids title = toolcap_monoids -description = TODO: write a description +description = an API to allow multiple sources to apply changes to a tools's capabilities. website = https://content.minetest.net/packages/rheo/toolcap_monoids/ author = flux license = AGPL-3.0-or-later