Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phasereditor2d/starter-template-basic-typescript
Basic TypeScript project template for Phaser Editor 2D.
https://github.com/phasereditor2d/starter-template-basic-typescript
2d-game editor html5-game ide phaser
Last synced: 25 days ago
JSON representation
Basic TypeScript project template for Phaser Editor 2D.
- Host: GitHub
- URL: https://github.com/phasereditor2d/starter-template-basic-typescript
- Owner: PhaserEditor2D
- Created: 2021-09-02T04:39:31.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-11T10:56:53.000Z (12 months ago)
- Last Synced: 2024-12-12T18:07:11.416Z (25 days ago)
- Topics: 2d-game, editor, html5-game, ide, phaser
- Language: TypeScript
- Homepage:
- Size: 124 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Basic TypeScript project template
[](https://gitpod.io/#https://github.com/PhaserEditor2D/starter-template-basic-typescript)
This is a Phaser Editor 2D v3 project template.
## Configuration
* It includes the latest Phaser v3 runtime as a node package.
* It is coded in TypeScript. The `tsc` is included as a node package.
* It includes a VS Code project configuration (`jsconfig.json` file).
## Compiles the source code
This project is based on TypeScript so for getting the game, first, you need to install TypeScript and other dependencies:
```bash
$ npm install
$ npm update
```
Then, for running the game, you need to compile the TypeScript files:
```bash
$ npm run build
```
It outputs the JavaScript code into the `game.js` file.
Often, you would like to run the TypeScript compiler in watch mode:
```bash
$ npm run watch
```
## Run the editor
* If you have NodeJS installed, you can run the editor using the `editor` NPM script, defined in the `package.json` file:
```bash
$ npm install
$ npm run editor
```
* If you are in a remote environment (like the Gitpod.io IDE), then run the editor like this:
```bash
$ npm run editor-remote
```
* If you want to see all the editor options, run:
```bash
$ npx phasereditor2d-launcher -help
```
* If Phaser Editor 2D Core is globally installed, you can run:
```bash
$ PhaserEditor2D -project .
```
## Gitpod
This repository is ready for start coding in Gitpod, a Cloud Development Environment. You only need to [click on this link](https://gitpod.io/#https://github.com/PhaserEditor2D/starter-template-basic-typescript) for starting a new workspace.
This is what Gitpod does:
- Creates a workspace for this project.
- Opens VS Code to edit this repo.
- Installs & updates the dependencies of this repo.
- Runs Phaser Editor 2D Core server in port `1959`.
In the **Ports** panel in VS Code, it shows the links for opening the editor (port `1959`). It gives you the options of copy the URL, open the URL in a preview panel, or open the URL in a new tab.