Custom emojis: import/export functions documentation.

This commit is contained in:
John Livingston
2024-06-10 19:29:03 +02:00
parent 6f56a026bb
commit 79848b7988
38 changed files with 1264 additions and 91 deletions

View File

@ -20,3 +20,23 @@ On the [channel configuration page](/peertube-plugin-livechat/documentation/user
{{% livechat_label livechat_configuration_channel_emojis_desc %}}
![Channel configuration / Channel emojis](/peertube-plugin-livechat/images/channel_custom_emojis.png?classes=shadow,border&height=400px)
### Import / Export
On the channel configuration page, there are an "{{% livechat_label action_import %}}" and an "{{% livechat_label action_export %}}" button.
The "{{% livechat_label action_export %}}" button generates a file than you can then import on another channel.
You can also generate a file to import from any other source (for example you can import your Twitch custom emojis).
The file must be a valid JSON file, using the following format:
```json
[
{
"sn": ":short_name",
"url": "https://example.com/image.png"
}
]
```
The `sn` attribute is the short name code.
The `url` attribute can be any image url than your browser can access, or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs) representing the file you want to import.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 63 KiB