OMGeeky/pytiled_parser
1
0
Fork 0
mirror of https://github.com/OMGeeky/pytiled_parser.git synced 2025-12-26 17:02:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(README): update readme

Browse Source
This commit is contained in:
Benjamin Kirkbride
2020-08-20 18:25:17 -04:00
parent 71c7390c00
commit 2bcb1caeea
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,8 +1,7 @@
# PyTiled Parser
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 a Python Library for parsing JSON formatted
[Tiled Map Editor](https://www.mapeditor.org/) maps and tilesets to be used as maps and levels for 2D top-down (orthogonal, hexogonal, or isometric) or side-scrolling games.
PyTiled Parser is not tied to any particular graphics library, and can be used
with [Arcade](http://arcade.academy),
@@ -10,7 +9,7 @@ with [Arcade](http://arcade.academy),
[Pygame](https://www.pygame.org/news), etc.
* Documentation available at: https://pytiled-parser.readthedocs.io/
* GitHub project at: https://github.com/pvcraven/pytiled_parser
* GitHub project at: https://github.com/Beefy-Swain/pytiled_parser
* PiPy: https://pypi.org/project/pytiled-parser/
The [Arcade](http://arcade.academy) library has
@@ -19,4 +18,10 @@ 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).
Significant contributions from [pvcraven](https://github.com/pvcraven) and [Cleptomania](https://github.com/Cleptomania).
## Developement
To develop pytiled parser, clone the repo, create a `venv` using a supported Python version, and activate it. Then install the package as well as all testing dependencies with the command `python -m pip install -e ".[tests]"`.
### Testing
Run `pytest --cov=pytiled_parser` to run the test harness and report coverage.