minecraft-text-canvas v1.2.1

• Installation
• Usage
  • Supported markup
• Acknowledgements
• License

Installation

This package requires Node.js =>18.12.0.

Install via the package manager of your choice:

$ npm install minecraft-text-canvas
$ yarn add minecraft-text-canvas
$ pnpm add minecraft-text-canvas

Usage

The following example renders a sample input text with some basic markup:

import render, { CHAT_CODES } from 'minecraft-text-canvas';

const result = render(`${CHAT_CODES.RED.code}Example ${CHAT_CODES.AQUA.code}text`);

The result variable is of type TextCanvasResult, which allows the image to be retrieved as a PNG/JPEG Buffer or a PNG/JPEG Stream.

For usage examples pertaining to Streams, see the node-canvas documentation on creating PNG and JPEG streams.

Supported markup

Acknowledgements

This repository was inspired by hypixel-fake-chat.

License

This is an open-source project under the MIT License.