Skip to content

Commit

Permalink
Merge pull request #51 from PhaserEditor2D/develop
Browse files Browse the repository at this point in the history
Merge develop
  • Loading branch information
PhaserEditor2D authored Jun 30, 2020
2 parents 978fc3a + 7ae73c4 commit e90b559
Show file tree
Hide file tree
Showing 136 changed files with 28,082 additions and 343 deletions.
79 changes: 79 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Build Guide

Phaser Editor 2D v3 is all based on web technologies. It has a server-side and an HTML5 client-side.

The server is a small, native program that serves the editor and project files and interacts with the Operating System.

The client is the bigger part and contains all the graphical user interface.

This repository contains all the client code. This means that you can modify it and build it.

The main two reasons you may find to build the client code are: you are contributing to the code or you want to try the in-development version.

## 1) Download the source code

First, you have to clone this repo to get the source code (you need a [Git client](https://git-scm.com/) installed).

```
$ git clone https://github.com/PhaserEditor2D/PhaserEditor2D-v3.git
```

By default, the current branch is `master`. It shows the latest, public version of the editor. To try the latest in-development changes, you should switch to the `develop` branch:

```
$ git checkout develop
```

If you want to contribute your modifications, you should create a pull request against the `develop` branch.

## 2) Install dependencies

Dependencies are managed with [NPM](https://www.npmjs.com/), you have to install it first.

```
$ cd PhaserEditor2D-v3/source/editor
$ npm install
```

## 3) Run the build script

```
$ ./build.sh
```

It should run the TypeScript compiler (installed in the `node_modules`) to compile the client's source code.

## 4) Download the latest Phaser Editor 2D binaries

Ok, you have the code of the client, but you need the server. The server is closed so you need to download the full latest version of the Phaser Editor 2D binaries.

It is available in the [Phaser Editor 2D downloads page](https://phasereditor2d.com/downloads).

It is distributed as a ZIP file. Unzip it.

## 5) Run the server with the new client

Now you can run the server but configure a new client. Look in the binaries you downloaded, there is a `PhaserEditor2D` executable file. Run it this way:

```
$ ./PhaserEditor2D -editor /path/to/PhaserEditor2D-v3/source/editor
```

The `-editor` option configures a new location of the client code. So, you have to write the full path to the `source/editor` folder of the repository you cloned.

## 6) Open the browser and run the IDE

Open this address in a browser:

```
http://127.0.0.1:1959/editor
```

Please, use a modern and updated browser.

If you used a previous version of the editor, it would be highly recommendable that you clean the browser cache while you load the new code.

Check in the Developer Console of the browser the version of the IDE.

If you have any issues, please, open an issue in this repository or contact us at `[email protected]`.
41 changes: 41 additions & 0 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
# Change Log

## Version 3.3.0 - July 1, 2020.

## Added

* Asset Pack: allows to import SVG files as HTML Image.
* Asset Pack: adds an Open button to the File Key section.
* Asset Pack: shows a Help link in the menu of the Inspector sections.
* Closes a couple of Input dialogs (New File, New Project, Rename File) when press ENTER in the input field.
* **Go To File** command `Ctrl+P`.
* Viewer dialog selects visible (or selected) item with the ENTER key.
* Filtered Viewer: allows pressing the Up/Down keys to focus the filter text or the viewer.
* Filtered Viewer: shows zoom buttons.
* Upload dialog: allows to drop files.
* Scene Editor: the Select Region tool.
* Scene Editor: scale proportionally if the `Shift` key is pressed when using the Scale tool.
* Scene Editor: arrow keys commands to change the position of the objects. Press `Shift` for 10x. It respects snap values.
* Scene Editor: enables copy/paste objects across scenes.
* Scene Editor: Inspector view sections show a menu with a Help item and related commands.
* Scene Editor: automatic creation of root container in a prefab scene.
* Scene Editor: in a prefab scene, non-prefab objects are renderer with transparency.
* [#41](https://github.com/PhaserEditor2D/PhaserEditor2D-v3/issues/41) Scene Editor: zoom in/out buttons.


## Modified

* Improved Asset Pack File section in Inspector view.
* [#44](https://github.com/PhaserEditor2D/PhaserEditor2D-v3/issues/44) Workbench: does not validate if there is an `index.html` file in the root folder.

## Fixed

* Fixes menu vertical positioning when there is few space at the top.
* Scene Editor: shows message when a prefab is not found.
* Scene Editor: fixes user property declaration when no initial value is provided.
* [#45](https://github.com/PhaserEditor2D/PhaserEditor2D-v3/issues/45) Scene Editor: compiler skips using field declarations in JavaScript output. It is not supported in Safari.
* Scene Editor: fixes scene compiler code merging when the output file was modified by formatters that replace tab chars with spaces.
* Scene Editor: fixes mouse wheel click on Safari.

## Version 3.2.0 - June 14, 2020

## Added
Expand All @@ -18,6 +55,10 @@

* Files view: the context menu **New** option does not open the **New File** dialog. Now it is a sub-menu with the shortcuts to create a new file of any supported content type.
* Scene Editor: the translate and rotate manipulators set integer values to objects.
* Scene Editor: in a prefab scene, the non-prefab objects are rendered with transparency, in the Outline view.
* Scene Editor: in a prefab scene, does not show the Inspector view's Variable and Lists sections if the selected object is the prefab object.
* Scene Editor: auto creates a container when add new objects to a prefab scene.
* Scene Editor: removes redundant `sceneType` attribute in scene file serialization.

## Fixed

Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@ Previous versions of the editor are based on the [Eclipse IDE](https://eclipse.o

*We are an independent developer. Phaser Editor is not part of the Phaser project. Contact them at [phaser.io](https://phaser.io)*


### Main features


* The IDE runs in the browser. It has a small backend that can be run in the cloud or locally.

* It is lightweight and is focused on visual tools.
Expand All @@ -26,7 +24,6 @@ Previous versions of the editor are based on the [Eclipse IDE](https://eclipse.o

* It follows the Phaser standards and API. Extra plugins or runtimes are not required.


### Documentation

Phaser Editor 2D v3 is [fully documented](https://help.phasereditor2d.com).
Expand All @@ -35,11 +32,13 @@ Phaser Editor 2D v3 is [fully documented](https://help.phasereditor2d.com).

Eventually, we share videos, screenshots, and thoughts about the editor's development progress.

* Check this [YouTube playlist](https://www.youtube.com/playlist?list=PLB8gI_5U0MvARFuAFCRQkQNR1tgLN7MMM) dedicated to the Phaser Editor 2D v3 development.
* Check this [YouTube channel](https://www.youtube.com/c/PhaserEditor2D) dedicated to the Phaser Editor 2D v3.

* Follow us on [Twitter @PhaserEditor2D](https://twitter.com/PhaserEditor2D) and [Facebook @PhaserEditor2D](https://facebook.com/PhaserEditor2D).

* Check the latest posts in the [Phaser Editor website](https://phasereditor2d.com).
* Check the latest tutorials in the [Phaser Editor website](https://phasereditor2d.com/blog/category/tutorials).

* Check the [#PhaserEditor2DTips](https://twitter.com/hashtag/PhaserEditor2DTips)

### Download

Expand All @@ -51,14 +50,17 @@ The [Play Phaser Editor 2D](https://play.phasereditor2d.com) is a service hosted

### Build and run

At this moment you cannot build and run Phaser Editor v3. The server is not part of this repository. As soon as the editor is released we are going to publish the instructions to build and run it.
[Follow these steps](https://github.com/PhaserEditor2D/PhaserEditor2D-v3/blob/develop/BUILD.md)

### Licensing

The code provided in this repository is under the MIT license.

The editor code is divided into two parts: the front-end (the HTML5-based IDE, or client) and the back-end (the HTTP server). This repository contains the full code of the client, that is the bigger part. The server code is closed.

### Contact

If you find any issue or have an idea, please, open an issue in this repository. Or contact us at `[email protected]` or say hi in our [Discord server](https://discord.com/invite/4DdpMMD).

### Author

Expand Down
Loading

0 comments on commit e90b559

Please sign in to comment.