summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index f2f2683..db5fc41 100644
--- a/readme.md
+++ b/readme.md
@@ -13,7 +13,8 @@ old fork in Carbone, under same license.
* awards.register_achievement(name, def)
* name
* desciption
- * sound [optional]
+ * sound [optional] - set a custom sound (SimpleSoundSpec) or `false` to play no sound.
+ If not specified, a default sound is played
* image [optional] - texture name, eg: award_one.png
* background [optional] - texture name, eg: award_one.png
* trigger [optional] [table]