matrix-wug/README.md

43 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# About
This is a bot for converting x- or z-sampa to IPA, or converting a custom ascii notation to standard PIE notation. Useful for e.g. linguistics and conlanging, and for creating powerful unicode emoticons.
Simply type your ascii inside // or [] with a prefixed x, z or p for x-sampa, z-sampa and PIE-notation respectively.
For instance:
x[sts_>q_hts_ht_hx] gives [st͡sʼqʰt͡sʰtʰx]
x/dZAn "m{d@n/ gives /d͡ʒɑn ˈmædən/
p[x2"owis x1"ek'wo:s-kve] gives *h₂ówis h₁é"kwōs-kʷe
Guides to these systems can be found here:
X-sampa: https://en.wikipedia.org/wiki/X-SAMPA
Z-sampa: https://web.archive.org/web/20191116002807/http://kneequickie.com/kq/Z-SAMPA
APIE: https://gist.github.com/xsduan/8ebd580be71214c57aa554ec9050916c
This is best learned by experimenting.
Inuktitut Syllabics: https://en.wikipedia.org/wiki/Inuktitut_syllabics
Iñupiatun Orthography:
* & for miniscule ł
* l% and n% for ł and ñ each
* g^, l^, &^ (or l%^ and l^%) n^, and r^ for ġ ḷ ł̣ ŋ ȓ each
These conversions were originally taken from [xsduan/conniebot](https://github.com/xsduan/conniebot), and the discord bot Tuugaalikkuluk (thanks!) But have later divirged a bit.
To use the bot I run an instance at [@wug:dodsorf.as](https://matrix.to/#/@wug:dodsorf.as), you can invite it to a room or DM it to use the converter. Or you can read the setup instructions below to host your own!
# Setup
1. Copy `config.json.example` to `config.json`
2. Change the homeserver value to your homeserver api url (i.e "https://matrix.dodsorf.as")
3. Change the token value to your users token. see https://t2bot.io/docs/access_tokens/ for how to get one.
4. `npm install` and `npm start`
You could also build a docker image but you're on your own there!
# Development
`npm install` and `npm start`
If you use nix you can run shell.nix to get node and npm in your environment.
If you use direnv you can also load the shell automatically