jcubic / cmatrix

Render Matrix effect animation on Canvas in JavaScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CMatrix - Matrix effect in JavaScript

npm LICENSE MIT

Matrix animation effect in JavaScript using Canvas

Installation

npm install cmatrix

Demos

Usage

You can use CDN:

<script src="https://cdn.jsdelivr.net/npm/cmatrix"></script>

and intialize the effect.

matrix(canvasElement, {
  chars: ['0', '1'],
  font_size: 16
}).
matrix(canvasElement, {
  chars: matrix.range(0x30A1, 0x30F6).concat(matrix.range(0x0030, 0x0039)),
  font_size: 16
}).

The matrix function return a Promise that is resolved when exit. By default, q and ESC exit from the effect. Use exit: false to disable ending the animation.

Repo Link

Options

  • chars - array of single character strings, by default Katagana and Hiragana (Japanese characters are used).
  • exit - by default matrix return a promise that resolves when it ends (when someone press q or ESC) this option when set to false will disable this and the function return undefined.
  • color - default color - default is #0f0.
  • background - by default it's set rgba(0, 0, 0, 0.05) alpha is required for the effect to look good.
  • font_size - number the default is 14.
  • font - name of the font (default monospace).

Static methods

  • matrix.range(start_number, end_number) - returns characters created from given range. Use matrix.range(0x30A1, 0x30F6) for Katagana characters and matrix.range(0x3041, 0x3096) for Hiragana, they look nice as matrix rain.

Changelog

0.3.0

  • add support for custom font

0.2.0

  • add exit/color/background options

0.1.1 / 0.1.0

  • Initial version

Acknowledge

License

Copyright (C) 2022 Jakub T. Jankiewicz
Released under MIT License

About

Render Matrix effect animation on Canvas in JavaScript

License:MIT License


Languages

Language:JavaScript 77.4%Language:HTML 22.6%