Updated readme
parent
a40ac5e442
commit
4cdee023ec
24
README.md
24
README.md
|
@ -2,8 +2,9 @@
|
|||
|
||||
## What is Unicode Parser
|
||||
Unicode Parser `unicodeparser` is a client-side mod (CSM) for [Minetest](https://www.minetest.net).
|
||||
It displays a window for you to write unicode codepoint then it will convert to
|
||||
real text string of that codepoint and send it out on public chat.
|
||||
It allows you write unicode codepoint in either \uXXXX format or \0xXXXX format
|
||||
then it will convert to real text string of that codepoint and send it out on
|
||||
public chat. Both GUI and CLI now available.
|
||||
|
||||
![The GUI](/images/thegui.png?raw=true "The GUI")
|
||||
|
||||
|
@ -22,21 +23,30 @@ text in Minetest (where the paste text appears as codepoints and not real text).
|
|||
|
||||
Run the included Python2 script under `tools` folder to write the usual text
|
||||
using your IME, click on "Convert" button, then copy (Ctrl-C) the output
|
||||
codepoint. In game, send `.ug` and a formspec will appear asking for input,
|
||||
paste (Ctrl-V) the codepoint and click on "Say".
|
||||
codepoint.
|
||||
|
||||
In game, to use GUI then send `.ug` and a formspec will appear asking for input,
|
||||
paste (Ctrl-V) the codepoint and click on "Say". To use CLI then send `.uc` followed
|
||||
by the unicode codepoint you want to convert.
|
||||
|
||||
### As workaround of paste problem
|
||||
|
||||
The codepoint appeared when you paste into Minetest itself is supposedly already
|
||||
in the same format needed by the CSM, so you don't need to run the Python2 script.
|
||||
Straight away send `.ug` in game and directly paste in the input, then click "Say".
|
||||
|
||||
In game, to use GUI then send `.ug` and directly paste in the input, then click "Say".
|
||||
To use CLI then send `.uc` followed by the unicode codepoint you want to convert.
|
||||
|
||||
## CSM in action
|
||||
![In Action](/images/inaction.gif?raw=true "In Action")
|
||||
|
||||
GUI version and as workaround of IME:
|
||||
![GUI In Action](/images/inaction.gif?raw=true "GUI In Action")
|
||||
|
||||
CLI version and as workaround of paste problem:
|
||||
![CLI In Action](/images/cli.gif?raw=true "CLI In Action")
|
||||
|
||||
## To do
|
||||
|
||||
- Release C++ and Java version of the tool
|
||||
- Include translation support (which seems to be impossible right now because CSM can't access other files)
|
||||
|
||||
## License
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 37 KiB |
Loading…
Reference in New Issue