https://github.com/somethingwithcomputers/phaser-fullscreen-typescript-vite-template
A Phaser fullscreen typescript vite template
https://github.com/somethingwithcomputers/phaser-fullscreen-typescript-vite-template
Last synced: 5 months ago
JSON representation
A Phaser fullscreen typescript vite template
- Host: GitHub
- URL: https://github.com/somethingwithcomputers/phaser-fullscreen-typescript-vite-template
- Owner: SomethingWithComputers
- Created: 2022-08-18T00:25:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-18T00:34:10.000Z (over 3 years ago)
- Last Synced: 2025-04-22T14:04:12.261Z (11 months ago)
- Language: TypeScript
- Size: 12.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Phaser Fullscreen Typescript Vite Template
Really rolls of the tongue doesn't it?
This should get you started with a fullscreen Phaser game.
It features:
- Full Vite development support for really fast recompilation and running;
- Full Typescript support;
- A working fullscreen template that fills the entire window perfectly;
- Boilerplate support for resizing the window;
- Reading of the `.env` file and an example on how to do it.
## Installation
To get started, simply execute:
```
npm install
```
And to use the `.env` file, simply rename `.env.example` to `.env`. On Mac you might have to do it via a terminal. From within the directory execute:
```
mv .env.example .env
```
## Getting started
For development, execute:
```
npm run develop
```
or if you want to access it from elsewhere within your network:
```
npm run develop-hosted
```
If you've finished your amazing game and you'd like to make an optimized build:
```
npm run build
```
The optimized build will appear in the `build` directory.
## Special thanks
[Phaser](https://phaser.io/) is an amazing game engine. I love it.
The feather image is based on an image from the awesome [Font Awesome](https://fontawesome.com/).