a/gosora
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add emoji docs

Browse Source
This commit is contained in:
Azareal 2020-07-15 19:03:10 +10:00
parent 96b61078c5
commit da5f383c5b
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuration.md
View File

@ -16,7 +16,7 @@ Plugin which you may not have run into is a category in which plugins can define
An example of what the file might look like: https://github.com/Azareal/Gosora/blob/master/config/config_example.json
Other configuration files: [config/weakpass.json](https://github.com/Azareal/Gosora/blob/master/docs/weak_passwords.md), emoji.json (WIP)
Other configuration files: [config/weakpass.json](https://github.com/Azareal/Gosora/blob/master/docs/weak_passwords.md), [config/emoji.json](https://github.com/Azareal/Gosora/blob/master/docs/emoji.md) (WIP)
# Site

13
docs/emoji.md Normal file
View File

@ -0,0 +1,13 @@
# Emoji
Emojis are a work in progress. We plan to implement UIs to input and pick them easily in the future. We also plan to make them more visually appealing and consistent.
Right now, you can input the emoji directly with an emoji keyboard, like those present on mobile devices or Windows 10 (WIN KEY + . OR WIN KEY + ;).
You can also input them if you know the shortcodes which are defined in the configuration files `config/emoji_default.json` or `config/emoji.json`. `emoji_default.json` should be left untouched as it gets updated with Gosora. Any additions should be made via `emoji.json`.
The file is a work in progress but it contains two sections: `no_defaults` and `emojis`.
`no_defaults` wipes clear anything defined by `emoji_default.json` to start over with a clean slate. You can set this to true to enable it or leave it absent to disable it.
`emojis` lets you create a list of emoji shortcodes which are substituted by the parser for Unicode emojis. You should only specify shortcodes which start and end with `:` here. We plan to add a section for literals like `:P` in the future.