Magic_Game/README.md

![Kiwano Logo](https://github.com/Nomango/Kiwano/raw/master/logo/logo_text_h.png)

# Kiwano Game Engine

[![Build status](https://ci.appveyor.com/api/projects/status/frqh09om9ldaklr9/branch/master?svg=true)](https://ci.appveyor.com/project/Nomango/kiwano/branch/master)
[![GitHub release](https://img.shields.io/github/release/nomango/kiwano)](https://github.com/Nomango/Kiwano/releases/latest)
[![GitHub license](https://img.shields.io/github/license/nomango/kiwano)](https://github.com/Nomango/Kiwano/blob/master/LICENSE)

English | [<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>](./README-zh.md)

## Introduction
Kiwano is a open-source 2D C++ game engine, only support win32 platform.

Kiwano-Core is a game irrelevant lib that provide a lot useful tools can be used in other projects. I made a lot wheels to make cpp simpler to use.

It's still under heavy developing. I write it and use it to developy my own tiny games.

You can move to [Kiwano Demos](https://github.com/kiwanogame/KiwanoDemos) repository to see how to use Kiwano to implement simple games.

More docs and examples will be added later.

## Features
* Scene management
* Transitions between scenes
* Action behaviours
* Buttons and menus
* Texture atlas support
* Audio support
* Custom data storage
* Physical engine (based on Box2D)
* GUI system (based on ImGui)

## Install

### Dev Environment

- Win8 or Greater (Win10 recommended)
- Visual Studio 2015 or Greater

### Install with NuGet

1. Open your Visual Studio solution
2. In Solution Explorer, right-click `References` and choose `Manage NuGet Packages`
3. Select the `Browse` tab, search for `kiwano`, select that package in the list, and select Install
4. Have a good trip with Kiwano !

### Install with source code

1. Clone or download source code from Github repository
2. Open your Visual Studio solution, right-click your solution in Solution Explorer, select `Add` and then `Existing item`
3. Select `.vcxproj` files in /projects folder which you downloaded in 1st step
4. Right-click your project and choose `Properties`, select C\C++ => General, add the root directory of kiwano project to the `Additional include directory` field
5. Right-click `References` and choose `Add Reference`, select `kiwano` project
6. Now you can build your own applications based on Kiwano source code !

## Next plan
* Cross-platform
* Particle system

## Contact
* Website: [kiwanoengine.com](https://kiwanoengine.com)
* QQ Group: 608406540
-												update appveyor.yaml

update README.md

											
										
										
											2019-08-05 12:32:05 +08:00
+								![Kiwano Logo](https://github.com/Nomango/Kiwano/raw/master/logo/logo_text_h.png)
-												update readme.md

											
										
										
											2019-07-08 17:23:49 +08:00
+								# Kiwano Game Engine
-												update appveyor.yaml

update README.md

											
										
										
											2019-08-05 12:32:05 +08:00
+								[![Build status](https://ci.appveyor.com/api/projects/status/frqh09om9ldaklr9/branch/master?svg=true)](https://ci.appveyor.com/project/Nomango/kiwano/branch/master)
-												update Simples project

update Simples project

update README.md

											
										
										
											2019-08-05 13:24:27 +08:00
+								[![GitHub release](https://img.shields.io/github/release/nomango/kiwano)](https://github.com/Nomango/Kiwano/releases/latest)
 								[![GitHub license](https://img.shields.io/github/license/nomango/kiwano)](https://github.com/Nomango/Kiwano/blob/master/LICENSE)
-												Update readme.md

											
										
										
											2017-09-27 18:03:06 +08:00
-												[chore] Update readme

											
										
										
											2020-01-21 10:34:38 +08:00
+								English | [<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>](./README-zh.md)
-												update introduction

											
										
										
											2017-12-15 23:15:06 +08:00
+								## Introduction
-												Easy2D project renamed to Kiwano

											
										
										
											2019-04-11 14:40:54 +08:00
+								Kiwano is a open-source 2D C++ game engine, only support win32 platform.
-												update introduction

											
										
										
											2017-12-15 23:16:57 +08:00
-												Easy2D project renamed to Kiwano

											
										
										
											2019-04-11 14:40:54 +08:00
+								Kiwano-Core is a game irrelevant lib that provide a lot useful tools can be used in other projects. I made a lot wheels to make cpp simpler to use.
-												update introduction

											
										
										
											2017-12-15 23:16:57 +08:00
 								It's still under heavy developing. I write it and use it to developy my own tiny games.
-												[chore] minor fixes

											
										
										
											2019-08-12 11:50:56 +08:00
+								You can move to [Kiwano Demos](https://github.com/kiwanogame/KiwanoDemos) repository to see how to use Kiwano to implement simple games.
-												[deploy] update README.md and fix appveyor.yml

											
										
										
											2019-08-08 15:20:02 +08:00
-												update introduction

											
										
										
											2017-12-15 23:15:06 +08:00
+								More docs and examples will be added later.
-												Update readme.md

											
										
										
											2017-09-27 18:03:06 +08:00
-												[chore] minor fixes

											
										
										
											2019-08-12 11:50:56 +08:00
+								## Features
 								* Scene management
 								* Transitions between scenes
-												[chore] Update readme

											
										
										
											2020-01-21 10:34:38 +08:00
+								* Action behaviours
-												[chore] minor fixes

											
										
										
											2019-08-12 11:50:56 +08:00
+								* Buttons and menus
 								* Texture atlas support
 								* Audio support
 								* Custom data storage
-												[chore] Update readme

											
										
										
											2020-01-21 10:34:38 +08:00
+								* Physical engine (based on Box2D)
 								* GUI system (based on ImGui)
-												[chore] minor fixes

											
										
										
											2019-08-12 11:50:56 +08:00
-												[deploy] update README.md and fix appveyor.yml

											
										
										
											2019-08-08 15:20:02 +08:00
+								## Install
 								### Dev Environment
 								- Win8 or Greater (Win10 recommended)
 								- Visual Studio 2015 or Greater
 								### Install with NuGet
 . Open your Visual Studio solution
 . In Solution Explorer, right-click `References` and choose `Manage NuGet Packages`
 . Select the `Browse` tab, search for `kiwano`, select that package in the list, and select Install
 . Have a good trip with Kiwano !
 								### Install with source code
 . Clone or download source code from Github repository
 . Open your Visual Studio solution, right-click your solution in Solution Explorer, select `Add` and then `Existing item`
 . Select `.vcxproj` files in /projects folder which you downloaded in 1st step
 . Right-click your project and choose `Properties`, select C\C++ => General, add the root directory of kiwano project to the `Additional include directory` field
 . Right-click `References` and choose `Add Reference`, select `kiwano` project
 . Now you can build your own applications based on Kiwano source code !
-												update introduction

											
										
										
											2017-12-15 23:15:06 +08:00
+								## Next plan
-												[chore] Update readme

											
										
										
											2020-01-21 10:34:38 +08:00
+								* Cross-platform
-												update introduction

											
										
										
											2017-12-15 23:15:06 +08:00
+								* Particle system
 								## Contact
-												update README.md

minor

minor

minor

											
										
										
											2019-07-22 12:59:23 +08:00
+								* Website: [kiwanoengine.com](https://kiwanoengine.com)
-												update introduction

											
										
										
											2017-12-15 23:15:06 +08:00
+								* QQ Group: 608406540