Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexis Huvier committed Mar 27, 2021
1 parent 107e684 commit 8339469
Show file tree
Hide file tree
Showing 6 changed files with 97 additions and 6 deletions.
3 changes: 3 additions & 0 deletions _static/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.wy-nav-content {
max-width: none;
}
4 changes: 4 additions & 0 deletions _templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{% extends "!layout.html" %}
{% block extrahead %}
<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
{% endblock %}
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ["_static"]
72 changes: 72 additions & 0 deletions engine/editor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Editor
======

One of principal components of PyEngine is the Editor.
He's composed of four other components.

Viewport
--------

In the center of the screen, there is the viewport.

You can see the current selected scene here.

.. warning:: The viewport haven't got any logic or game loop.

ProjectExplorer
---------------

At the bottom, there is the project explorer.

You can choose if you want see scripts, prefabs, textures or scenes.
If you rightclick on the right part, you can create new assets or delete an old one.

Scripts
^^^^^^^

A Script in PyEngine4 is a python file where you create a logic for an object.

On creation, PyEngine4 ask a name for the script.
If you doubleclick on it, you will open the script.

Prefabs
^^^^^^^

*Coming Soon*

Textures
^^^^^^^^

A texture is a .PNG or .JPG file with can be use for a sprite.

On creation, PyEngine4 ask a name and a path to the file.
If you doubleclick on it, you will be able to change the path.

Scenes
^^^^^^

A scene is a 2D world where you can put objects. You must have a scene for any game.

On creation, PyEngine4 ask a name for the scene.

SceneTree
---------

On the left, you can see the Scene Tree.

It show the objects which is in the current selected scene.

You can create a new game object with selected an already existed game object and make a rightclick.
You will choose a name and the new game object will be the child of the existed.

You can also delete game object with a rightclick.

Inspector
---------

On the right, there is the inspector.

This panel will show the properties and components from the selected game object (or asset in the case of texture).

You can add a new component in a normal game object with the button on the bottom or with rightclick.
You can also delete component of a normal game object with rightclick.
10 changes: 10 additions & 0 deletions engine/project_window.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
ProjectWindow
=============

The first window you will see when you launch PyEngine4 is the ProjectWindow.

This window list all the projects of PyEngine4. You can launch a project with a doubleclick.

.. note:: An project made with an other version of PyEngine will not be launched.

You can also delete an existed project or create a new projet with a name, an author and an icon (the last is not obligatory).
12 changes: 7 additions & 5 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ Sommaire :
Informations/faq
Informations/changelog

Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. toctree::
:maxdepth: 1
:caption: Engine
:name: sec-Engine

engine/project_window.rst
engine/editor.rst

0 comments on commit 8339469

Please sign in to comment.