mregggga/sitelen-pona-ucsur-guide

o sitelen e sitelen pona lon ilo mute a!

sitelen pona UCSUR guide!!!

o sitelen e sitelen pona lon ilo mute a!

Render sitelen pona on most desktop applications!

Due to the standardization of codepoints in the UCSUR, you can now render sitelen pona on many desktop applications (Firefox, Discord, etc). In many applications all you need to do is install a UCSUR compatible sitelen pona font, and you are good to go. However there are some quirks, and you need an input engine to be able to easily input these characters, which is the purpose of this guide.

Fonts

The current recomended fonts for sitelen pona are:

• Fairfax HD

  

  This font supports the latest (2024-02-20) version of UCSUR. It does not look a bit nasa, however it is mostly readable.

• nasin nanpa

  

  This is an alternative font, actively being developed by jan Itan (@etbcor). It is monospace, and supports cartouches, combination glyphs, and long glyphs (pi, tawa & lon). This font supports the 2024-02-20 version of UCSUR, and is used in su!.

• sitelen seli kiwen juniko (mono)

  

  This font by jan Lepeka supports the most recent version of UCSUR (2024-02-20). It's personally my favorite! There are proportional (glyphs take up varying amounts of space) and monospaced (glyphs take up the same amount of space) versions of the font. Monospaced fonts in general are recommened for sitelen pona (both of the above fonts are monospaced). sitelen seli kiwen juniko mono, the monospaced version of sitelen seli kiwen juniko is used in the css below, fyi.

If you are unsure of which font to pick, I would recommend nasin nanpa.

Once you have installed any of these fonts you are done, in many applications sitelen pona should render correctly, with the exception of websites, as they do not fall back to sitelen pona. This is an issue, because some applications are actually websites, with a notable example being Discord.

Discord

Because internally the Discord application relies on Electron, it does not fall back to the font you installed when sitelen pona glyphs are present, instead displaying these frustrating little squares. To fix this, one option is to install a fake Helvetica Neue font, which will allow sitelen pona to render wherever Helvetica Neue is used, which includes Discord!

Another option is to modify your Discord. Currently, this modification is possible on all Desktop systems. This option is dangerous, violates Discord TOS, and may result in your account being banned.

Font

Simply install the fake Helvetica Neue font, and it should result in Discord displaying UCSUR.

For Windows,

• Download and install this font

For Linux,

• Cownload the above font
• Copy the file to ~/.local/share/fonts/

This method does not work on macOS or mobile devices.

Desktop

⚠️⚠️⚠️ THIS VIOLATES DISCORD'S TOS. O SONA A ⚠️⚠️⚠️

To patch your Discord to correctly render sitelen pona on desktop, we will use the Vencord client modification. Start by following the installation guide on their website to install it. After installing Vencord we need to add a CSS snippet, this is a small snippet of code that tells Vencord to use Fairfax HD or nasin nanpa when sitelen pona is present.

First go to go to Settings, then scroll down to "Vencord", click "Themes", and press "Edit QuickCSS"

Paste the sitelen-pona.css file into the text box (click the link, then press Ctrl + A then Ctrl + C. Then, paste the text into the text box.) Remember to remove the @-moz-document domain("discord.com") { line from the code!

Once you have pasted the code into the QuickCSS box, you can now exit settings, your Discord should be properly set up to render sitelen pona!

Browser

If you use a web browser, you can use the stylus extension to help render sitelen pona.

Simply install this userstyle and you're done!

Android

I do not own an Android phone, so I cannot give an accurate guide on this section (maybe somebody fill this in with a pull request), however kulupu Mimuki (@.mouseless) has put together an excellent video guide for achieving this with Aliucord.

~ the previous text here, tan jan Lili

There used to be a video guide for viewing sitelen pona in Aliucord by kulupu Mimuki. However, the video link is now dead, nor have I been able to get sitelen pona working in Aliucord. But this reddit post is a wonderful guide on how to get UCSUR sitelen pona on Android. Regarding viewing sitelen pona, here are the listed steps:

Installing the font:

1. Download nasin-nanpa-2.5.1.otf. (Please note that the latest version will not work; the latest version of nasin nanpa now translations Latin characters as well as UCSUR, which messes things up).

2. Convert nasin-nanpa-2.5.1.otf to nasin-nanpa-2.5.1.ttf (If you're not sure how, skip this step or click the link).

3. Download zFont 3 from the Play Store. (Other font changing apps such as #mono_ might work instead)

4. In the app, go to Downloads, press the + icon in the bottom right and add the font file (select "Add File"). (If you didn't convert it, the app will prompt you to install another app and you can do it there if you need).

5. Click on the font file and press Apply.

6. The app will ask you for your Android version, choose "Auto".

7. Follow the steps in the app, they vary depending on your phone, for me it involved installing a fake Samsung font.

8. Once you're done you should now be able view sitelen pona in every app.

You should be able to read this: 󱥞󱤘󱤮󱤉󱥁

Input

Now that sitelen pona is rendering properly, we need to be able to type it!

Windows

There are two input methods for Windows: nasin Ajemi and nasin AHK

You can download & install nasin Ajemi from this link, see the README on how to use it.

For nasin AHK, there is an Auto Hotkey Script (download with Ctrl+S) by jan Itan (@etbcor) for input. Write the toki pona word and then a ` (the letter under escape) to convert it into sitelen pona. You can also write [` and ]` for cartouches, as well as (` and )` for long glyphs. There is also a "small" version of the script that uses 3 letter codes for each word instead of typing the whole word.

For this of this to work, you need to have Auto Hotkey installed.

Other features of the script are explained near the bottom of nasin-nanpa's releases page.

macOS

jan Tepo (@tbodt) has made an input plugin for macOS with modifications by jan Semu (@jmiibo) to support UCSUR (download with Ctrl+S). Download it, then install it by double clicking. Then enable it in System Preferences -> Keyboard -> Input Sources. You'll find it listed under "Chinese, Simplified".

Linux

The only (nasin sitelen Wakalito li lon · ilo ante kin li lon) current supported input engine for Linux is ibus, for this to work, you need both ibus, and ibus-tables installed. For installation commands/instructions, see this page.

During installation, regarding Ubuntu, feel free to remove ibus-qt4 from the apt-get insall command, which has been removed from Ubuntu's main repository.

jan Komi (@cominixo) has created an ibus input table (click the link & download with Ctrl+S). Copy it to a directory of your choice, and then open a terminal in the same directory. Run these commands to install it:

sudo ibus-table-createdb -n /usr/share/ibus-table/tables/tokipona.db -s tokipona.txt
ibus-daemon -drxR

Once you have done this, open the ibus preferences (you can do this with the ibus-setup command). Go to Input Method, click Add and then select sitelen pona (the last option under the English category).

Finally, if necessary, go to your keyboard settings in your settings application and add a "sitelen pona" input source (the name should be "English (sitelen pona)").

This should result in a new tray icon which indicates which input source you're using — English or sitelen pona. Which keybinding which allows you to switch input sources may depend on your distro. However, on Pop!_OS it is Super + Space

List format for instructions

1. Install ibus and ibus-tables. Follow the instructions on this page.

   • For Ubuntu, do not install the ibus-qt4 package

2. Download the ibus input table here.

3. Copy the file to a chosen directory and open a terminal in the directory

4. Run these two commands:

sudo ibus-table-createdb -n /usr/share/ibus-table/tables/tokipona.db -s tokipona.txt

ibus-daemon -drxR

5. Open ibus preferences (you may run the ibus-setup command)

6. Add the sitelen pona input method. Go to Input Methods -> Add -> English -> (scroll all the way down to) sitelen pona

7. If needed, go to your settings application and add a new input source of the name "English (sitelen pona)"

   • Feel free to search for "sitelen pona" and select anything similar, if "English (sitelen pona)" is not present

8. Switch input sources (either via keybindings or the tray icon).

9. pini a!

Espanso / nasin sitelen Wakalito

nasin Wakalito is an input method for writing Toki pona words. It is available on macOS, Linux, and Windows using Espanso. By default, nasin Wakalito outputs words in sitelen Lasina. However, by using a modified config file, we can output UCSUR instead.

In addition, if you just need/want to use Espanso and don't like the triggers in nasin Wakalito, there is also a config file for that (sitelen-pona-espanso.yml).

nasin:

1. Install Espanso here

2. Download a config file. There are two:

   • This file uses nasin Wakalito's triggers, and outputs UCSUR

   • This file uses toki pona word triggers with \ as en ending character (e.g. meli\, kala\), and outputs UCSUR

3. Copy or move the file to Espanso packages folder

   • Windows: C:\Users\<user>\AppData\Roaming\espanso\match\packages

     • (Win+R, type %appdata% to get to \Roaming)

   • macOS: /Users/<user>/Library/Preferences/espanso/match/packages

   • Linux: /home/<user>/.config/espanso/match/packages

4. Start Espanso

5. Start writing!

   • A table for triggers -> words can be found on sona.pona.la, here, with a few modifications listed below. This is for the first config file, wakalito-7-3-2-ucsur.yml.

Modifications

Character	Keys on a QWERTY layout
(fullwidth space)	666, (3 spaces)
‍ ("-" zero width joiner)	aa
󱦕 ("^" stacking joiner)	gg
󱦖 ("*" scaling joiner)	hh
󱦝 (":" sp colon)	6y
󱦜 ("·" sp dot)	3
󱦐 ("[" cartouche start)	c1
󱦑 ("]" cartouche end)	c2
「 (cjk start quote)	q1
」 (cjk end quote)	q2
󱦗 ("(" start left-combining long glyph)	b1
󱦘 (")" end left-combining long glyph)	b2
󱦚 ("{" start right-combining long glyph)	d1
󱦛 ("}" end left-combining long glyph)	d2

Android

Two input engines for android exist:

• jan Komi's (@cominixo) (similar Y better APKs can be found in this reddit post)

  • When trying to install the APK, if you get an error that you cannot due to "package conflicts," delete the other Toki Pona Keyboard app and try again.

• and kulupu Mimuki's (@.mouseless) which can be used with this app, but it requires a paid addon to import the file.

Web

If you are on a device which cannot use these input methods for any reason, jan Tala (@at) has created a web based converter from sitelen Lasina to sitelen pona.

End

This is a really huge step for toki pona, and I am extremely happy to see this happen. If you have created a font, input method, or any other resource that you want added, please create a pull request, issue, or just ping me on discord @o.v (jan Lili lon ma pona pi toki pona) and we can talk!

*~ tan jan Lili*

ijo pona

thank you to

• jan Komi
• kulupu Mimuki
• jan Tala
• soweli pona Tesa
• mun Kekan San
• jan Tepo
• jan Itan
• jan Lili
• jan Semu
• ijo @Qwerty-Space (lon lipu github)
• ijo @ReveredOxygen
• kulupu katu

sina ale li pona wawa a li pana sona e pona anu pali pona a (anu ni tu a a)