Readme update

This commit is contained in:
Philippe Roy 2022-07-21 00:19:48 +02:00
parent 3f54e0a1ab
commit e7b75b267d

View File

@ -1,22 +1,43 @@
# CodeTower
**Code your tower (coding tower defense)**
**Code your tower ! (coding tower defense)**
CodeTower is a Tower Defense coding game where the towers are driven by Python code.
CodeTower is a Tower Defense coding game where the towers are driven by Python code.
* [Screencast](http://www.phroy.org/cloud/index.php/s/djBtGFSXBfCFJM7)
**Stop the minions waves with your favorite editing software !**
It's a early prototype. CodeTower is a open source software distributed under the terms of the [GPLv3 license]('https://www.gnu.org/licenses/gpl-3.0.html').
[![CodeTower - Gameplay](img/screen-04-ytb.png)](https://www.youtube.com/watch?v=snZaTSre8FA "CodeTower - Gameplay")
The game engine is [Blender](https://blender.org) / [UPGE](https://upbge.org).
![Screenshot](img/screenshot-01.jpg)
It's a early prototype.
CodeTower is a open source software distributed under the terms of the [GPLv3 license](https://www.gnu.org/licenses/gpl-3.0.html).
The game engine is open source : [Blender](https://blender.org) / [UPBGE](https://upbge.org).
Assets (3D models, sounds, icons) : [Kenney]( https://www.kenney.nl/ ) and [Kaylousberg](https://www.kaylousberg.com).
### Download
Source repository (Gitlab) : https://gitlab.com/phroy/codetower
* itch.io : [itch.io / codetower](https://phroy.itch.io/codetower)
Binaries (GNU/Linux and Windows) : [www.phroy.org](http://www.phroy.org/cloud/index.php/s/nyoWT6xMkxAJ9Pm)
* Source repository (Gitlab) : https://gitlab.com/phroy/codetower
* Binaries repository (GNU/Linux and Windows) : [www.phroy.org](http://www.phroy.org/cloud/index.php/s/nyoWT6xMkxAJ9Pm)
### Python script
The Python script is the file **"ct_cmd.py"** (in the game folder), you have to edit it with your favorite editing software (Spyder, Emacs, Atom, ...).
### Map commands
The level points will be spent for build or upgrade. So you have to know your level before action.
* **Get your level : ct_level ()**
- Return your level (integer)
* **Time management (temporization) : ct_sleep (delay)**
- delay : duration in seconds (float)
### Tower commands
@ -24,8 +45,6 @@ With your Python script, you can build, remove and upgrade your towers.
For each tower, you will be able to choose dynamically most appropriate techno (archer tower) or spell (mage tower).
The Python script is the file **ct_cmd.py** (in the game folder), you have to edit it with editing software (Spyder, Emacs, Atom, ...).
* **Build a tower : ct_build (x, y, category, name, color, style)**
- x position (integer)
- y position (integer)
@ -41,9 +60,3 @@ The Python script is the file **ct_cmd.py** (in the game folder), you have to ed
* **Remove a tower : ct_remove (x, y)**
- x position (integer)
- y position (integer)
* **Get your level : ct_level ()**
- Return your level (integer)
* **Time management (temporization) : ct_sleep (delay)**
- delay : duration in seconds (float)