Skip to content

Commit

Permalink
Update to PhaserEditor 4.
Browse files Browse the repository at this point in the history
  • Loading branch information
PhaserEditor2D committed Apr 9, 2024
1 parent 793ac4d commit dffc458
Show file tree
Hide file tree
Showing 8 changed files with 340 additions and 362 deletions.
20 changes: 0 additions & 20 deletions .gitpod.yml

This file was deleted.

6 changes: 6 additions & 0 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Changelog

## v2.0.0 - Apr 9, 2024

* Migrates to Phaser Editor v4.

## v1.1.0 - Dec 4, 2023

* Migrates to the new libraries.
Expand Down
50 changes: 4 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Spine + Webpack + TypeScript project template for Phaser Editor 2D
# Spine + Webpack + TypeScript project template for Phaser Editor v4

[![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-spine)

A project template for Phaser 3, Spine, Webpack 5, TypeScript, and Phaser Editor 2D v3.
A project template for Phaser 3, Spine, Webpack 5, TypeScript, and Phaser Editor v4.
It also includes a workflow for deploying the game to GitHub Pages.

## Spine
Expand Down Expand Up @@ -43,20 +41,6 @@ This project requires [Node.js](https://nodejs.org) and [NPM.js](https://www.npm

It is generated in the `/dist` folder.

## 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-webpack) 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 the Webpack development server in port `8080`.
- Runs Phaser Editor 2D Core server in port `1959`.

In the **Ports** panel in VS Code, it shows the links for opening the game (port `8080`) & 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.

## Hosting your game on GitHub Pages

If you are looking for a hosting for you game, GitHub Pages is a very nice and free option.
Expand All @@ -75,32 +59,6 @@ If you don't want to deploy your game to GitHub Pages, then you can remove the `

In this video I explain many of these concepts: [Start making a game in the cloud. GitHub + VS Code + Phaser Editor 2D [Tutorial]](https://www.youtube.com/watch?v=lndU7UAjzgo&t=183s)

## Run the editor

* You can run the editor using the `editor` NPM script, defined in the `package.json` file:

```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 .
```

## Phaser Editor 2D considerations

### Excluding files from the project
Expand Down Expand Up @@ -151,8 +109,8 @@ The Scenes, User Components, and ScriptNodes are configured to compile to TypeSc
The project requires the following script libraries:
* [@phasereditor2d/scripts-core](https://www.npmjs.com/package/@phasereditor2d/scripts-core)
* [@phasereditor2d/scripts-simple-animations](https://www.npmjs.com/package/@phasereditor2d/scripts-simple-animations)
* [@phaserjs/editor-scripts-core](https://www.npmjs.com/package/@phaserjs/editor-scripts-core)
* [@phaserjs/editor-scripts-simple-animations](https://www.npmjs.com/package/@phaserjs/editor-scripts-simple-animations)
You can add your script nodes to the `src/script-nodes` folder.
Expand Down
Loading

0 comments on commit dffc458

Please sign in to comment.