Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/remarkablegames/phaser-jsx

📝 Use JSX in Phaser
https://github.com/remarkablegames/phaser-jsx

game javascript jsx library npm pacakge phaser react typescript ui

Last synced: 10 days ago
JSON representation

📝 Use JSX in Phaser

Awesome Lists containing this project

README

        

# phaser-jsx

[![NPM](https://nodei.co/npm/phaser-jsx.png)](https://nodei.co/npm/phaser-jsx/)

[![NPM version](https://img.shields.io/npm/v/phaser-jsx.svg)](https://www.npmjs.com/package/phaser-jsx)
[![build](https://github.com/remarkablegames/phaser-jsx/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablegames/phaser-jsx/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/remarkablegames/phaser-jsx/graph/badge.svg?token=EZEOFDL9ME)](https://codecov.io/gh/remarkablegames/phaser-jsx)

📝 Use [JSX](https://facebook.github.io/jsx/) in [Phaser](https://phaser.io/).

### Examples

- [CodeSandbox](https://codesandbox.io/p/devbox/phaser-jsx-9ldp6n)
- [Replit](https://replit.com/@remarkablemark/phaser-jsx)
- [JSFiddle](https://jsfiddle.net/remarkablemark/dLhvuo42/)
- [Examples](https://github.com/remarkablegames/phaser-jsx/tree/master/examples)

## Quick Start

With JSX:

```tsx
// index.jsx
import Phaser from 'phaser';
import { Text, render } from 'phaser-jsx';

new Phaser.Game({
scene: {
create() {
render(, this);
},
},
});
```

Without JSX:

```ts
// index.js
import Phaser from 'phaser';
import { jsx, render } from 'phaser-jsx';

new Phaser.Game({
scene: {
create() {
render(jsx(Phaser.GameObjects.Text, { text: 'Hello, world!' }), this);
},
},
});
```

## Install

[NPM](https://www.npmjs.com/package/phaser-jsx):

```sh
npm install phaser-jsx
```

[Yarn](https://yarnpkg.com/package/phaser-jsx):

```sh
yarn add phaser-jsx
```

[CDN](https://unpkg.com/browse/phaser-jsx/):

```html

```

## Usage

ES Modules:

```ts
import { createElement, render } from 'phaser-jsx';
```

CommonJS:

```ts
const { createElement, render } = require('phaser-jsx');
```

UMD:

```html

const { render, jsx } = window.PhaserJSX;

```

## TypeScript

For better type support, install [@types/react](https://www.npmjs.com/package/@types/react):

```sh
npm install @types/react --save-dev
```

Import the [GameObject](https://docs.phaser.io/phaser/concepts/gameobjects) from `phaser-jsx` instead of `phaser`:

```ts
import { Text } from 'phaser-jsx';
```

> [!TIP]
> All GameObjects exported from `phaser-jsx` are aliases of the GameObjects from `phaser`.

Update your `tsconfig.json`:

```json
{
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "phaser-jsx"
}
}
```

## Vite

Update your Vite config:

```ts
// vite.config.mjs
import { defineConfig } from 'vite';

export default defineConfig({
esbuild: {
jsxImportSource: 'phaser-jsx',
},
});
```

### JSX Pragma

If you're not using `jsxImportSource`, you can set a JSX pragma at the top of your file:

```tsx
/** @jsx jsx */
import { jsx } from 'phaser-jsx';
```

## How Does It Work?

This package follows [React](https://react.dev/) conventions like having `createElement` and `jsx-runtime`.

The `render` function renders game objects inside a scene.

If you need nesting and relative positioning, use `Container`:

```tsx


```

## Hooks

### `useRef`

Create a ref for your game object:

```ts
import { useRef } from 'phaser-jsx';

function MyComponent() {
const textRef = useRef();
// ...
}
```

Pass your ref to the JSX element:

```tsx
// ...
return ;
```

Access your game object:

```ts
function handleClick() {
textRef.current?.text = 'Clicked';
}
```

Alternatively, you can get the game object with a callback ref:

```tsx
{
gameObject.text = 'Hello, world!';
}}
/>
```

### `useScene`

Retrieve the current Scene with the `useScene` hook:

```ts
import { useScene } from 'phaser-jsx';

function MyComponent() {
const scene = useScene();
// ...
}
```

> [!WARNING]
> Don't use the `useScene` hook if you start multiple Scenes.

Type your Scene with TypeScript:

```ts
class MyScene extends Phaser.Scene {
// ...
}

const scene = useScene();
```

## Release

Release is automated with [Release Please](https://github.com/googleapis/release-please).

## License

[MIT](https://github.com/remarkablegames/phaser-jsx/blob/master/LICENSE)