-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #51 from PhaserEditor2D/develop
Merge develop
- Loading branch information
Showing
136 changed files
with
28,082 additions
and
343 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
@@ -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). | ||
|
@@ -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 | ||
|
||
|
@@ -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 | ||
|
||
|
Oops, something went wrong.