doric-engine/README.md

49 lines
2.0 KiB
Markdown

# Doric Engine
The **Doric Engine** is an open source game engine for turn-based, strategy games played on a hexagonical grid system.
**Doric** uses [Kivy](http://kivy.org/) under the hood, and had its origin during the **Game Camp** sprint at PyCon
US 2016.
## Getting Started
1. Install Python 3 with dependencies.
1. For Ubuntu ```sudo apt-get install python3 python3-dev libjpeg-dev libgl1-mesa-dev libgles2-mesa-dev \
libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev zlib1g-dev```
1. Create a Python 3 virtualenv.
1. Install Cython `pip install Cython==0.23`
1. Install Kivy and other requirements: `pip install -r requirements.txt`
1. Run the game using: `python main.py`
## Packaging the Game
For desktop OS: `pyinstaller doric-desktop.spec`
For Android OS: `buildozer android debug`
## License
Unless otherwise indicated (with an explicit LICENSE file):
* Source code for this project is released under the [MIT License](http://choosealicense.com/licenses/mit/)
* All other files and assets (e.g. graphics, sound files, Jupyter Notebooks) are released under the [Creative Commons Attribution 4.0 International Public License](http://creativecommons.org/licenses/by/4.0/legalcode) (CC-BY 4.0)
## Game Camp
Game Camp is an open-source project aimed at helping anyone learn to make mobile games using Python, by developing
teaching materials and tutorials that make the process fun and accessible. It is based on Python and Kivy, and targets
Android and IOS devices. We are looking for developers, educators, designers from a wide variety of backgrounds and
skill levels to help us develop the Game Camp materials.
### Contacting Us
Game Camp is maintained by
* Kjell Wooding: kjell@learnleapfly.org
* Amy Wooding: amy@learnleapfly.org
Documentation and Chat:
* Wiki: https://github.com/learnleapfly/gamecamp/wiki
* Chat: https://llf-game-camp.slack.com (contact Amy for access!)
### About Learn Leap Fly
* Website: http://learnleapfly.org
* Twitter: [@LearnLeapFly](http://twitter.com/learnleapfly)