Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix titles in README and add Tiled deps #241

Open
wants to merge 1 commit into
base: 2.2-release
Choose a base branch
from
Open

Fix titles in README and add Tiled deps #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,48 +6,48 @@ An entity-component architecture is used to control game object state and the lo

KivEnt is built with a modular architecture and designed to have both a python api and a c-level cython api that allows more performant access to your game data. This makes it suitable for quickly prototyping a mechanic completely in python, and relatively trivial to then deeply cythonize that GameSystem if you find it to be performance sensitive. This process has already been done for the built-in components meaning they are ready for you to build new, performant game systems on top of them.

##Project Website:
## Project Website:
http://www.kivent.org

##Mailing List:
## Mailing List:
https://groups.google.com/forum/#!forum/kivent

##Documentation:
## Documentation:
http://www.kivent.org/docs

##Getting Started
## Getting Started
Read the [introduction](https://github.com/kivy/KivEnt/wiki/An-Introduction-to-KivEnt) on the github wiki.

##Dependencies
## Dependencies
KivEnt is split into modules, the core module, 'kivent_core', is dependent only on Kivy.

Other modules may have other dependecies, listed here:

###kivent_core:
### kivent_core:
* [kivy](https://github.com/kivy/kivy)

###kivent_cymunk:
### kivent_cymunk:
* [kivy](https://github.com/kivy/kivy)
* [cymunk](https://github.com/tito/cymunk)
* [kivent_core](https://github.com/kivy/KivEnt/tree/master/modules/core)

###kivent_particles
### kivent_particles
* [kivy](https://github.com/kivy/kivy)
* [kivent_core](https://github.com/kivy/KivEnt/tree/master/modules/core)

###kivent_maps
### kivent_maps
* [kivy](https://github.com/kivy/kivy)
* [kivent_core](https://github.com/kivy/KivEnt/tree/master/modules/core)
* also Tiled based deps, udiboy1209 we need to add the deps here
* [python_tmx](https://pypi.python.org/pypi/tmx)

###kivent_projectiles
### kivent_projectiles
* [kivy](https://github.com/kivy/kivy)
* [kivent_core](https://github.com/kivy/KivEnt/tree/master/modules/core)
* [cymunk](https://github.com/tito/cymunk)
* [kivent_cymunk](https://github.com/kivy/KivEnt/tree/master/modules/cymunk)
* [kivent_particles](https://github.com/kivy/KivEnt/tree/master/modules/particles)

##Installation
## Installation
first install all dependencies then:

cd .../KivEnt/modules/core
Expand All @@ -72,7 +72,7 @@ or:
python setup.py build_ext --inplace
export PYTHONPATH=/path/to/KivEnt/modules/cymunk:$PYTHONPATH

##Windows Kivy Portable Package Installation:
## Windows Kivy Portable Package Installation:

Open the kivy-2.7.bat (kivy-3.4.bat if using the py3 portable package) command console and type:

Expand All @@ -95,7 +95,7 @@ Assuming you have KivEnt in the root folder for the portable package, in the kiv
cd ../../examples/6_controlling_the_viewing_area
python main.py

##Tested On:
## Tested On:
Tested with [master branch](https://github.com/kivy/kivy). Python 2.7 and Python 3.4.

Tested on Android, Ubuntu, Windows, OSX; iOS coming soon!
Expand Down