search

hywax / phaser-font-plugin

Phaser 3 plugin to load fonts
MIT License
2 stars 0 forks source link
font loader phaser-plugin phaser3 phaserjs plugin

readme

Phaser Font Plugin

npm version npm downloads License

Phaser Font Plugin is a lightweight plugin that allows you to load fonts in your Phaser 3 game.

🎯 Features

✨ Installation

# Using pnpm
pnpm add phaser-font-plugin

# Using yarn
yarn add phaser-font-plugin

# Using npm
npm install phaser-font-plugin

⚡ Usage

Load the plugin

Add the plugin to the list of global plugins in your game configuration.

import { Game } from 'phaser'
import { FontPlugin } from 'phaser-font-plugin'

export default new Game({
  plugins: {
    global: [
      {
        key: 'FontPlugin',
        plugin: FontPlugin,
        start: true,
      },
    ],
  },
})

Use the plugin

Use the plugin to load fonts in your scenes.

import { Scene } from 'phaser'

export default class Boot extends Scene {
  preload() {
    this.load.font('pixeloid', 'assets/fonts/pixeloid.ttf')
  }
}

🌟 Credits

A huge thank you to everyone who is helping to improve Phaser Font Plugin. Thanks to you, the project can evolve!

Contributors

To become a contributor, please follow our contributing guide.

contributors

📝 License

Licensed under the MIT License.