https://github.com/psethwick/plover_fancytext
Fancytext plugin for Plover
https://github.com/psethwick/plover_fancytext
plover plugin stenography unicode
Last synced: 3 months ago
JSON representation
Fancytext plugin for Plover
- Host: GitHub
- URL: https://github.com/psethwick/plover_fancytext
- Owner: psethwick
- License: gpl-3.0
- Created: 2020-06-06T21:53:26.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-15T19:21:21.000Z (almost 3 years ago)
- Last Synced: 2024-09-30T02:34:37.321Z (8 months ago)
- Topics: plover, plugin, stenography, unicode
- Language: Python
- Homepage: https://pypi.org/project/plover-fancytext/
- Size: 88.9 KB
- Stars: 12
- Watchers: 2
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
****************************
Fancy Text Plugin for Plover
****************************
This is a plugin for the open source stenography program `Plover `_
Requires Plover version 4.0.0 or later
.. image:: https://github.com/psethwick/plover_fancytext/workflows/Tests/badge.svg
:target: https://github.com/psethwick/plover_fancytext/actions?query=workflow%3ATests
.. image:: https://img.shields.io/pypi/v/plover_fancytext.svg
:target: https://pypi.org/project/plover-fancytext/
.. image:: https://img.shields.io/pypi/dm/plover_fancytext.svg
:target: https://pypi.org/project/plover-fancytext/
What it does
############
Allows you to use Plover to write *fancy* text
Transformers:
* blackboardbold: ๐น๐๐๐๐๐๐ ๐๐ฃ๐ ๐น๐ ๐๐, ๐๐๐ ๐ป๐ ๐ฆ๐๐๐ ๐๐ฅ๐ฃ๐ฆ๐๐
* bubble: โโคโโโโ
* crytyping: I' finne,,, h ddon'nt w,,,orry about me, re,,el yy
* fullwidth: ๏ฝ๏ฝ๏ฝ๏ฝ๏ฝ๏ฝ๏ฝ๏ฝ๏ฝ
* medieval: ๐ธ๐๐๐๐๐๐๐
* monospace: ๐๐๐๐๐๐๐๐๐
* morse: ... --- ...
* sarcasm: wELl ThIs IS cONvEnIeNt
* script: ๐ข๐ฌ๐ป๐ฒ๐น๐ฝ ๐ฏ๐ธ๐ป ๐ฝ๐ฑ๐ช๐ฝ ๐ฑ๐ช๐ท๐ญ๐๐ป๐ฒ๐ฝ๐ฝ๐ฎ๐ท ๐ต๐ธ๐ธ๐ด
* smallcaps: Sแดแดสส Cแดแดs
* upsidedown: ndsแดpว poสu
* uwu: Hewwoooo <3 this aww you nyeed.
* UwU: uwuwuwu, buwut mowe :3 Nyote that this may get in the way of conwewsations :3 :3 :3
* zalgo: zฬaอlฬgฬฬฉoอกtฬeฬxอ อtฬฌฬ
* figlet:
::
MMMMMMMM MMMMMMMM
M:::::::M M:::::::M
M::::::::M M::::::::M
M:::::::::M M:::::::::M
M::::::::::M M::::::::::M ooooooooooo ooooooooooo
M:::::::::::M M:::::::::::M oo:::::::::::oo oo:::::::::::oo
M:::::::M::::M M::::M:::::::Mo:::::::::::::::oo:::::::::::::::o
M::::::M M::::M M::::M M::::::Mo:::::ooooo:::::oo:::::ooooo:::::o
M::::::M M::::M::::M M::::::Mo::::o o::::oo::::o o::::o
M::::::M M:::::::M M::::::Mo::::o o::::oo::::o o::::o
M::::::M M:::::M M::::::Mo::::o o::::oo::::o o::::o
M::::::M MMMMM M::::::Mo::::o o::::oo::::o o::::o
M::::::M M::::::Mo:::::ooooo:::::oo:::::ooooo:::::o
M::::::M M::::::Mo:::::::::::::::oo:::::::::::::::o
M::::::M M::::::M oo:::::::::::oo oo:::::::::::oo
MMMMMMMM MMMMMMMM ooooooooooo ooooooooooo
Installing
##########
1. Open Plover
2. Navigate to the Plugin Manager tool
3. Select 'plover_fancytext' in the list
4. Click install
5. Restart Plover
6. If you just want the retro commands, you're done!
Extra steps for the extension plugin (which enables the
``{:fancytext_set:}`` commands):
1. In the Configure menu, navigate to the plugins section
2. Enable 'plover_fancytext' and apply
Usage
#####
You can either apply transformations with
``{:fancytext_retro::}``
which will replace ```` retroactively with fancy text. Example:
``{:fancytext_retro:2:bubble}`` to bubble-ize the last two words.
Or you can use ``{:fancytext_set:}`` to turn on
a mode until you turn it back off!
The format is ``{:fancytext_set:}`` to turn on the mode and simply ``{:fancytext_set:off}`` to turn off any mode.
Here's what I use (``23*9`` is more easily read as ``#TP*T``):
::
{
"23*9": "{:fancytext_set:off}",
"23*9/PW-UB": "{:fancytext_set:bubble}",
"23*9/KRAO-EU": "{:fancytext_set:crytyping}",
"23*9/SRA-EUP": "{:fancytext_set:fullwidth}",
"23*9/PH-ED": "{:fancytext_set:medieval}",
"23*9/SA-RBG": "{:fancytext_set:sarcasm}",
"23*9/-UP": "{:fancytext_set:upsidedown}",
"23*9/AO-U": "{:fancytext_set:uwu}",
"23*9/AO*U": "{:fancytext_set:UwU}",
"23*9/STKPWA-L": "{:fancytext_set:zalgo}"
}
Mode Notes
##########
It's worth noting that these modes will not always work with Plover's
orthography rules. Some modes will be more wrong than others
The zอฬถaฬlฬฌgฬอoฬ mอฬoฬฌฬชdฬeฬฬน can also take two arguments for the minimum and maximum number
of combining marks. Example ``{:fancytext_set:zalgo:10:15}`` for quite a lot of
zอฬออฎฬฬอฃออฬฬนฬฉอaฬออฬฬอ
ฬฌฬตออคอฬฬฬผ lฬคอฬฬฝฬฟอฬอฌอออฉฬ ฬญฬตgฬฬอฉฬฒออฬงอฃอฌฬอฬออจoฬออฆอฬฬอฬขฬดอญอฃ. For reference the default is min=1, max=3
You may want the ใ๏ฝ๏ฝ๏ฝ๏ฝใ๏ฝ๏ฝ๏ฝ๏ฝ๏ฝใmode to use a full-width space. This can be done by
setting space in the same entry: ``{:fancytext_set:fullwidth}{MODE:SET_SPACE:ใ}``.
If you do this you'll probably also want to add ``{MODE:RESET}`` to your entry which turns
off the mode
This trick can also be applied to the upside down mode.
Include unicode 202e (right to left mark) as well as a space character for um, a
good time. You'll definitely want ``{MODE:RESET}`` on this one, and you might want
to add unicode 202d (left to right mark) to it as well. You don't want to use
these marks anywhere where text needs to be precisely correct, but should be
fine in many places. I've not included it as part of the mode because it is definitely an acquired
taste and can end up with you having text backwards after you turn the mode off
Figlet is only set up to work with ``fancytext_retro``. This is because the output is multi-line text
for individual words. It takes a ``font`` argument, you can use most `figlet fonts `_
Contributing
############
Want a new mode? Having problems?
Head to the `open source repository `_
Feel free to:
* Raise an issue
* Open a pull request, new modes accepted!