LandofKittens
/
sticker-tools
mirror of https://git.pleroma.social/absturztaube/sticker-tools.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

add disclaimer

This commit is contained in:
Absturztaube 2020-04-04 19:43:25 +02:00
parent eb15458727
commit 200d05810b
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -2,46 +2,50 @@
This script helps to install and setup stickers for pleroma-fe
!!!THIS MIGHT BE VERY BUGGY AND MIGHT NOT WORK!!!
!!!DIDN'T TEST IT IN PRODUCTION YET!!!
!!!USE AT YOUR OWN RISK!!!
## configuration
the script looks for `config.json`. if it doesnt find it, it will fallback to `default.json`
you can also use `-c <configfile>` to point it to a specific config
you can also use `-c <configfile>` to point it to a specific config
just copy `default.json` to `config.json` and set `.pleroma.static` accordingly
just copy `default.json` to `config.json` and set `.pleroma.static` accordingly
## usage
show a list of available commands
show a list of available commands
```
./stickers.sh help
```
check dependencies for this script. make sure you have those tools installed otherwise the script will fail at various points
check dependencies for this script. make sure you have those tools installed otherwise the script will fail at various points
```
./stickers.sh check deps
```
prepares your pleroma-fe for stickers. it creates an empty stickers.json.
prepares your pleroma-fe for stickers. it creates an empty stickers.json.
```
./stickers.sh prepare
```
build a pack from a folder of images. the pack will be created in the release directory and is ready to install
build a pack from a folder of images. the pack will be created in the release directory and is ready to install
```
./stickers.sh build <path/to/images>
```
installs a pack to pleroma and adds it to stickers.json.
installs a pack to pleroma and adds it to stickers.json.
```
./stickers.sh install <path/to/pack>
```
recreates the stickers.json from packs already added to pleroma-fe.
recreates the stickers.json from packs already added to pleroma-fe.
```
./stickers.sh recreate
```
grabs a pack from another instance. if you don't specify a pack, it will list all packs it can find on that instance and lets you choose
grabs a pack from another instance. if you don't specify a pack, it will list all packs it can find on that instance and lets you choose
```
./stickers.sh grab instance <instance> [<pack>]
```