aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..51ccb52
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# SVC Intercom
+
+**SVC Intercom** is a plugin for Simple Voice Chat that adds broadcasting functionality, meaning you can talk to everyone
+inside a world in a one way system, everyone can hear you, along with people close to them.
+
+## Commands:
+
+`/intercom live <player> <world> <duration>` Start broadcasting `player`s microphone to everyone in `world` for `duration` seconds
+
+`/intercom info <world>` Shows active broadcasts in a world
+
+`/intercom file <filename> <world>` Plays `filename` for everyone in `world` for the duration of the file
+
+`/intercom stop <world>` Stops the broadcast in `world` \ No newline at end of file