Giter Site home page Giter Site logo

sitelen-pona-ucsur-guide's Introduction

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

    an image preview of fairfax hd

    This font supports the 2022-05-20 version of UCSUR. It looks a bit nasa, however it is mostly readable.

  • nasin nanpa

    an image preview of linja nanpa

    This is an alternative font, actively being developed by jan Itan (@etbcor#6146). It is monospace, and supports cartouches, combination glyphs, and long glyphs (pi, tawa & lon). This font supports the 2022-05-20 version of UCSUR.

  • insa pi supa lape

    an image preview of insa pi supa lape

    This font by /dev/urandom/ supports an outdated version of UCSUR (2022-01-31).

If you are unsure of which font to pick, I would recomend linja 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, sadly the only option is to modify your Discord. Currently, this modification is possible on all Desktop systems, and on Android.

Desktop

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

First go to "User Settings" in Discord, then scroll down to "Themes" and click the "Quick CSS" tab.

Paste this snippet of code into the text box. (No need to worry about security! CSS can only change visual aspects of Discord, not steal your login token or act on your behalf)

:root {
    --font-primary: Whitney,"Helvetica Neue",Helvetica,Arial,sans-serif,"linja-nanpa","Fairfax HD","insa pi supa lape";
    --font-display: Ginto,"Helvetica Neue",Helvetica,Arial,sans-serif,"linja-nanpa","Fairfax HD","insa pi supa lape";
    --font-code: Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace,"linja-nanpa","Fairfax HD","insa pi supa lape";
    --font-headline: Ginto Nord,Ginto,"Helvetica Neue",Helvetica,Arial,sans-serif,"linja-nanpa","Fairfax HD","insa pi supa lape";
}

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

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 (rats#0976) has put together an excellent video guide for achieving this with Aliucord.

Browser

If you use a web browser, you can use the stylus extension to add the css code above. Simply click on the extension with a discord tab open, and use the "write a style for:" menu. Be sure to no accidentally write it for "this url", as that will make it not work outside of the channel you were looking at.

Input

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

Windows

If you use windows, there is an Auto Hotkey Script (download with ctrl+s) by jan Itan (@etbcor#6146) 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 any 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#7244) has made an input plugin for macOS with modifications by jan Semu (rhythm heaven monkey#9052) to support the 2022-05-20 version of UCSUR (download with ctrl+s). Install it by double clicking. Then enable it in System Preferences > Keyboard > Input Sources. You'll find it listed under "Chinese, Simplified" for some reason.

Linux

The only current supported input engine for Linux is ibus, for this to work, you need both ibus, and ibus-tables installed.

jan Komi (cominixo#5443) has created an ibus input table (download with ctrl+s). Copy it to a directory of your choice, and then open a command line in the same directory. Run these commands to install it.

an image of the ibus input engine in action

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, go to Input Method, click ADD and then select sitelen pona (the last option under the English category). Cartouches are typed with '[', '_', and ']'. Long pi is started with 'pi_' and extended with '.

Android

Two input engines for android exist:

Web

If you are on a device which cannot use these input methods for any reason, jan Tala (@at#0754) 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 @8o7wer#4073 (jan Lili lon ma pona pi toki pona) and we can talk!

sitelen-pona-ucsur-guide's People

Contributors

etbcor avatar id405 avatar mregggga avatar qupufu avatar reveredoxygen avatar smeagolthellama avatar tbodt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

sitelen-pona-ucsur-guide's Issues

Powercord is EOL

According to powercord's discord server, it's EOL since July 2022. What are we supposed to use instead?

Update Fairfax HD screenshot

A new version was released on 2022-05-22 which improved a lot of glyphs. It looks a lot less nasa now (I hope).

uh you know css isn't actually secure right?

the readme says "CSS can only change visual aspects of Discord". this is not technically true, it has been shown that css injection alone can be used to send text printed on a webpage to an attacker, which is particularly important for discord. i'm sure you're not doing anything dangerous with it but you should maybe change that section.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.