Skip to content

Commit a933d8d

Browse files
author
Arian Fornaris
committed
Docs: fix some links on First steps.
1 parent bd54ce5 commit a933d8d

File tree

3 files changed

+17
-13
lines changed

3 files changed

+17
-13
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ hs_err_pid*
2020
*.zip
2121
*.dylib
2222
*.DS_Store
23+
24+
docs/_build/**

docs/first_steps.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ Download and install
1313
`Download the Phaser Editor ZIP file <http://phasereditor.boniatillo.com/blog/downloads>`_ of your OS (win64, linux64 or macosx) and uncompress it.
1414

1515
Notes for Windows users
16-
~~~~~~~~~~~~~~~~~
16+
~~~~~~~~~~~~~~~~~~~~~~~
1717

1818
To execute the editor just double click on the ``PhaserEditor.exe`` file.
1919

2020
Notes for MacOS users
21-
~~~~~~~~~~~~~~~
21+
~~~~~~~~~~~~~~~~~~~~~
2222

2323

2424
To execute the editor double click on the ``Phaser Editor`` application. It is a simple ``.app`` folder. By default the projects will be created in the ``~/Library/PhaserEditorProjects`` folder.
2525

2626
Notes for Linux users
27-
~~~~~~~~~~~~~~~
27+
~~~~~~~~~~~~~~~~~~~~~
2828

2929
Before to run the editor you should set execution permission to some programs bundled in Phaser Editor. To do this, run the ``SetPermissions.sh`` script:
3030

@@ -50,7 +50,7 @@ Some users are getting issues at the editor startup. Please `check this issue to
5050
5151
5252
The first run
53-
-----------
53+
-------------
5454

5555
The first time you run Phaser Editor a Workspace Launcher dialog is open. In this dialog you have to set the path to the folder where you want to create the workspace.
5656

@@ -62,14 +62,14 @@ A project is a folder where you add the code of your game. So you can create man
6262

6363

6464
Update
65-
---------
65+
------
6666

6767
By default when the editor opens it checks for available updates. We recommend you to install them, important bug fixes are provided this way.
6868

69-
`Learn more about the update process <Learn more about the update process>`_
69+
`Learn more about the update process <update.html>`_
7070

7171
Create a project
72-
--------------
72+
----------------
7373

7474
In Phaser Editor there is two way of create a Phaser project, by using the **Phaser Project** wizard or the **Phaser Example Project** wizard.
7575

@@ -92,16 +92,18 @@ So, by pressing **Next** the wizard shows the settings page:
9292

9393
This page contain some group of parameters that affect different aspects of a project:
9494

95-
* **Game Parameters** are the same parameters of the ``Phaser.Game`` constructor. Set these parameters to control how the game instance is created.
96-
* **Project Structure** contains a list of project layouts that you can select. You can select to create a project with a very simple structure or a complex, production ready structure. These layout are related with the number of Phaser states are going to be used in the game.
97-
* **Assets**. In this section you can set if you want to add some demo assets to the project. This could be good if you want to take a better idea of how a Phaser project is. In many of the layouts, when you select to add assets, some prefabs are created so it is a good way to know how prefabs work.
98-
* **TypeScript** is a parameter that if it is checked all the code of the project will be generated to TypeScript instead of JavaScript. At the time there is not a built-in TypeScript editor inside Phaser Editor but we included this option because developers can use any other external editor like `VSCode <http:// .visualstudio.net>`_. There are some third-party plugins for Eclipse that support TypeScript, `here we talk about one of them <http://phasereditor.boniatillo.com/blog/2017/04/welcome-typescript-ide>`_.
95+
=============================== ===================================================
96+
``Game Parameters`` Are the same parameters of the ``Phaser.Game`` constructor. Set these parameters to control how the game instance is created.
97+
``Project Structure`` Contains a list of project layouts that you can select. You can select to create a project with a very simple structure or a complex, production ready structure. These layout are related with the number of Phaser states are going to be used in the game.
98+
``Assets`` In this section you can set if you want to add some demo assets to the project. This could be good if you want to take a better idea of how a Phaser project is. In many of the layouts, when you select to add assets, some prefabs are created so it is a good way to know how prefabs work.
99+
``TypeScript`` Is a parameter that if it is checked all the code of the project will be generated to TypeScript instead of JavaScript. At the time there is not a built-in TypeScript editor inside Phaser Editor but we included this option because developers can use any other external editor like `VSCode <http:// .visualstudio.net>`_. There are some third-party plugins for Eclipse that support TypeScript, `here we talk about one of them <http://phasereditor.boniatillo.com/blog/2017/04/welcome-typescript-ide>`_.
100+
=============================== ===================================================
99101

100102
After set the parameters then press the **Finish** button to create the project and files.
101103

102104
In dependence of your layout one file or other will be open to start editing the game. Usually what is opened is a visual scene file (canvas file) so you can start adding new objects to the game.
103105

104-
`Learn more about the scene editor <http://phasereditor.boniatillo.com/blog/quick-start/080-canvas>`_
106+
`Learn more about the scene editor <canvas.html>`_
105107

106108
Phaser Example Project wizard
107109
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/jseditor.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ In Phaser Editor if you annotate the prototype with the ``BaseClass`` then in th
8181
.. image:: images/TypeDecl_Prototype.png
8282
:alt: Prototype type annotation.
8383

84-
Note that we annotate an intermediate ``MyGroup_proto`` var with the ``Phaser.Group` type, then we assign this var to the new prototype declaration.
84+
Note that we annotate an intermediate ``MyGroup_proto`` var with the ``Phaser.Group`` type, then we assign this var to the new prototype declaration.
8585

8686
.. code::
8787

0 commit comments

Comments
 (0)