]> nmode's Git Repositories - signal-cli/commitdiff
Add documentation for sticker upload
authorAsamK <asamk@gmx.de>
Mon, 23 Mar 2020 13:48:52 +0000 (14:48 +0100)
committerAsamK <asamk@gmx.de>
Mon, 23 Mar 2020 13:49:21 +0000 (14:49 +0100)
man/signal-cli.1.adoc

index 4101986f0b13078a258aa5893b4e39ad8465d58b..98a547568a1a56a52eb99b2fe07ef0b70badf8ca 100644 (file)
@@ -287,6 +287,34 @@ sendContacts
 Send a synchronization message with the local contacts list to all linked devices.
 This command should only be used if this is the master device.
 
 Send a synchronization message with the local contacts list to all linked devices.
 This command should only be used if this is the master device.
 
+uploadStickerPack
+~~~~~~~~~~~~~~~~~
+Upload a new sticker pack, consisting of a manifest file and the stickers in WebP
+format (maximum size for a sticker file is 100KiB).
+The required manifest.json has the following format:
+
+```json
+{
+  "title": "<STICKER_PACK_TITLE>",
+  "author": "<STICKER_PACK_AUTHOR>",
+  "cover": { // Optional cover, by default the first sticker is used as cover
+    "file": "<name of webp file, mandatory>",
+    "emoji": "<optional>"
+  },
+  "stickers": [
+    {
+      "file": "<name of webp file, mandatory>",
+      "emoji": "<optional>"
+    }
+    ...
+  ]
+}
+```
+
+PATH::
+       The path of the manifest.json or a zip file containing the sticker pack you
+       wish to upload.
+
 daemon
 ~~~~~~
 signal-cli can run in daemon mode and provides an experimental dbus interface. For
 daemon
 ~~~~~~
 signal-cli can run in daemon mode and provides an experimental dbus interface. For