Skip to content

Commit

Permalink
Fix Getting Started documentation (#71)
Browse files Browse the repository at this point in the history
* Fix Creating Player Character: use ESCAnimationName resources to set up animations, not ESCAnimationResource

* Update directions to create an Escoria project.

* Consistently refer to Pub scene rather than Park scene in Create Roo m docs.

* Update link to ESC language reference.
  • Loading branch information
cidneyhamilton authored Aug 17, 2023
1 parent d64bc58 commit 7f628ce
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 4 deletions.
6 changes: 6 additions & 0 deletions getting_started/step_by_step/1_create_escoria_project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ To make starting with Escoria as easy as possible, we provide a Godot Game
Template along with stock user interfaces and dialog managers to get you up and
running in no time.

.. hint::

The version of Escoria in Godot's Template Libraries is out of date.
To make sure you have the latest version, clone the develop branch
of the [Escoria Demo Game](https://github.com/godot-escoria/escoria-demo-game)
and copy over the addons folder.

Game filesystem structure
-------------------------
Expand Down
4 changes: 2 additions & 2 deletions getting_started/step_by_step/2_create_player_character.rst
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,8 @@ specific animations for the character for each direction angle:
* ``Idles``: Idle animations
* ``Speaks``: Speaking animations

For each direction angle, add an ``ESCAnimationResource``. Then, click each
``ESCAnimationResource`` and put the name of the matching animation
For each direction angle, add an ``ESCAnimationName``. Then, click each
``ESCAnimationName`` and put the name of the matching animation
(with the name specified in "Adding a walkcycle" above) in the "Animation"
field, and choose whether that animation should be played mirrored by selecting
the "Mirrored" checkbox.
Expand Down
2 changes: 1 addition & 1 deletion getting_started/step_by_step/3_create_room.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ room scene we'll now create: Let's call it "pub".
Create a new scene and set ``ESCRoom`` as its root node. Save the scene as
"pub.tscn".

* Note that you could call the scene something other than "park.tscn" -
* Note that you could call the scene something other than "pub.tscn" -
"room1.tscn" for example. Make sure you name things in a way that makes sense
to your game.

Expand Down
2 changes: 1 addition & 1 deletion getting_started/step_by_step/9_continuing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Congratulations! You've built your very first game with Escoria. Well done!
But obviously, there's a lot more to do. We recommend checking out the rest
of the documentation. For example:

* :doc:`The ESC reference </getting_started/z_esc_reference>`
* :doc:`The ESC reference </scripting/z_esc_reference>`
* :doc:`The Escoria settings reference </getting_started/z_escoria_settings>`
* :doc:`A walk through Escoria's architecture </advanced/escoria_architecture>`
* :doc:`How to create your own UI </advanced/create_ui>`
Expand Down

0 comments on commit 7f628ce

Please sign in to comment.