Skip to content

Commit

Permalink
- continuing documentation (level building tutorial)
Browse files Browse the repository at this point in the history
  • Loading branch information
sven1977 committed Jul 11, 2017
1 parent 96ef3a1 commit a44f897
Show file tree
Hide file tree
Showing 109 changed files with 5,561 additions and 1,423 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,6 @@ instance/
# Scrapy stuff:
.scrapy

## Sphinx documentation
docs/_build/

# PyBuilder
target/

Expand Down
20 changes: 10 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
########################
Quick Setup Instructions
########################
========================

.. image:: https://raw.githubusercontent.com/sven1977/spygame/master/examples/platformer_2d/screen2.png
.. figure:: https://raw.githubusercontent.com/sven1977/spygame/master/examples/platformer_2d/screen2.png
:alt: The Lost Vikings - Sample spygame Level

*All graphics are (c) Blizzard Entertainment Inc (The Lost Vikings)*
The Lost Vikings - Sample spygame Level - *All graphics are (c) Blizzard Entertainment Inc (The Lost Vikings)*


Get the code
Expand Down Expand Up @@ -64,10 +63,10 @@ level background images and level setup (collision layers, background images, po

This should give you a level like this:

.. image:: https://raw.githubusercontent.com/sven1977/spygame/master/examples/maze_runner/screen1.png
.. figure:: https://raw.githubusercontent.com/sven1977/spygame/master/examples/maze_runner/screen1.png
:alt: The Maze Runner - An A-maze-ing Game :)

*All graphics are (c) Blizzard Entertainment Inc (The Lost Vikings)*
The Maze Runner - An A-maze-ing Game :) - *All graphics are (c) Blizzard Entertainment Inc (The Lost Vikings)*

You can now control the Agent via the four arrow keys (up, down, left, right).

Expand All @@ -77,8 +76,9 @@ Please only use these (in your own projects and repos) for demonstration purpose
Next steps
----------

If you would like to create more complex levels (or entire Games with many Screens and Levels), read the spygame documentation, in which we'll
create a full-blown 2D platformer Level (sorry, documentation is still very WIP!).
If you would like to create more complex levels (or entire Games with many Screens and Levels), read the
`spygame documentation <https://sven1977.github.io/spygame/>`_, in which we'll create a full-blown 2D platformer Level
(sorry, documentation is still very WIP!).

AI (Reinforcement Learning) with spygame
----------------------------------------
Expand All @@ -97,9 +97,9 @@ If you would like to contribute to the spygame library, the following items are
- create support for GUI elements (label, buttons, tick-boxes, etc..). This is an open Pygame problem and should probably be solved on the Pygame level.
- help out with integrating spygame into openAI-gym and openAI-rllab repos

.. image:: https://raw.githubusercontent.com/sven1977/spygame/master/examples/platformer_2d/screen1.png
.. figure:: https://raw.githubusercontent.com/sven1977/spygame/master/examples/platformer_2d/screen1.png
:alt: Lost Vikings - Sample spygame Level

*All graphics are (c) Blizzard Entertainment Inc (The Lost Vikings)*
Lost Vikings - Sample spygame Level - *All graphics are (c) Blizzard Entertainment Inc (The Lost Vikings)*


2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = spygame
SOURCEDIR = .
BUILDDIR = _build
BUILDDIR = ..

# Put it first so that "make" without argument is like "make help".
help:
Expand Down
4 changes: 0 additions & 4 deletions docs/_build/html/.buildinfo

This file was deleted.

Empty file removed docs/_build/html/.nojekyll
Empty file.
Loading

0 comments on commit a44f897

Please sign in to comment.