https://github.com/phasereditor2d/starter-template-basic-javascript

Basic JavaScript project template for Phaser Editor 2D
https://github.com/phasereditor2d/starter-template-basic-javascript

editor html5-game javsacript phaser

Last synced: 24 days ago
JSON representation

Basic JavaScript project template for Phaser Editor 2D

• Host: GitHub
• URL: https://github.com/phasereditor2d/starter-template-basic-javascript
• Owner: PhaserEditor2D
• Created: 2021-09-01T18:53:30.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-11T10:50:07.000Z (12 months ago)
• Last Synced: 2024-01-11T16:53:41.422Z (12 months ago)
• Topics: editor, html5-game, javsacript, phaser
• Language: JavaScript
• Homepage:
• Size: 2.43 MB
• Stars: 5
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Basic JavaScript project template

[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/PhaserEditor2D/starter-template-basic-javascript)

This is a Phaser Editor 2D v3 project template.

## Configuration

* It includes the latest Phaser v3 runtime (in the `lib/` folder).

* It is coded in JavaScript.

* It includes a VS Code project configuration (`jsconfig.json` file) and the type definitions (in the `types/` folder).

## Run the editor

If you have NodeJS installed, you can run the editor using the `editor` NPM script, defined in the `package.json` file.

First you have to install & update the dependencies:

```bash

$ npm install

$ npm update

```

And then you can run the editor:

```bash

$ 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 to 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-javascript) to start 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 option of copying the URL, opening the URL in a preview panel, or opening the URL in a new tab.

## Script Nodes

Script nodes are logic objects. You can add a script node to the scene or a game object, for extending it with custom data and behavior.

This project includes the script libraries:

- [@phasereditor2d/scripts-core](https://github.com/PhaserEditor2D/phasereditor2d-scripts-core)

- [@phasereditor2d/scripts-simple-animations](https://github.com/PhaserEditor2D/phasereditor2d-scripts-simple-animations#duration-config)