README.md

RuneScape Text

Convert text to a text image with RuneScape chat effects.

More examples

Getting started

npm i runescape-text

If you're on Windows and installation fails due to issues with canvas, follow the instructions at https://github.com/Automattic/node-canvas/wiki/Installation:-Windows to install the necessary dependencies. You can find installation instructions for other operating systems in the same wiki.

Examples

npx runescape-text "glow3:wave:hello world"

import { writeFileSync } from "node:fs";

import getRuneScapeText from "runescape-text";

const message = "glow3:wave:hello world";
const options = { debug: true };
const { data, extension } = getRuneScapeText(message, options);

writeFileSync(`./runescape-text.${extension}`, Buffer.from(data));

References

• Chat effect guides:

  • https://oldschool.runescape.wiki/w/Chat_Interface#Chat_effects
  • https://www.wikihow.com/Write-Text-Effects-on-Runescape

• Color chart reference for the pattern color effect: