Documentation updates

This commit is contained in:
Paul Vincent Craven
2019-08-15 09:33:49 -05:00
parent 4f8a534921
commit 0670005d3e
10 changed files with 229 additions and 57 deletions

View File

@@ -1,4 +1,20 @@
# pytiled_parser
Python Library for parsing Tiled Map Editor maps.
# PyTiled Parser
NOT READY FOR USE
PyTiled Parser is a Python Library for parsing
[Tiled Map Editor](https://www.mapeditor.org/) (`.tmx`) files used to generate
maps and levels for 2D top-down or side-scrolling games.
PyTiled Parser is not tied to any particular graphics library, and can be used
with [Arcade](http://arcade.academy),
[Pyglet](https://pyglet.readthedocs.io/en/pyglet-1.3-maintenance/),
[Pygame](https://www.pygame.org/news), etc.
Documentation available at: https://pytiled-parser.readthedocs.io/
The [Arcade](http://arcade.academy) library has
[supporting code](http://arcade.academy/arcade.html#module-arcade.tilemap) to
integrate PyTiled with that 2D libary, and
[example code](http://arcade.academy/examples/index.html#tmx-files-tiled-map-editor) showing its use.
Original module by [Beefy-Swain](https://github.com/Beefy-Swain).
Contributions from [pvcraven](https://github.com/pvcraven).