An open API service indexing awesome lists of open source software.

https://github.com/fszewczyk/shkyera-engine

Easy-to-Use, game engine for Python
https://github.com/fszewczyk/shkyera-engine

game-development game-engine physics-engine python-game

Last synced: 4 days ago
JSON representation

Easy-to-Use, game engine for Python

Awesome Lists containing this project

README

          

![Shkyera Engine](docs/img/title_img.png)





![Documentation](https://github.com/fszewczyk/shkyera-engine/actions/workflows/doxygen.yml/badge.svg)
![LinuxBuild](https://github.com/fszewczyk/shkyera-engine/actions/workflows/linux.yml/badge.svg)
![MacOSBuild](https://github.com/fszewczyk/shkyera-engine/actions/workflows/macos.yml/badge.svg)
![LICENSE](https://img.shields.io/badge/license-Beerware-yellow)

_Under development. Some of the information may not be up to date. See the roadmap [here](https://trello.com/b/mVROG8st/shkyera-engine)_

Shkyera Engine is an open-source game engine written in C++, designed to allow everyone to create visual applications. The engine's goal is to create a very easy interface that allows for creating fully functional 3D experiences.

See the [documentation](https://fszewczyk.github.io/shkyera-engine) for a comprehensive guide and tutorials.

Requirements

1. [CMake](https://cmake.org/)
2. Compiler supporting C++17, e.g. [Clang 5](https://releases.llvm.org/download.html)

Download the repository with its submodules.

```
git clone --recursive git@github.com:fszewczyk/shkyera-engine.git
```

Enter the root directory of the downloaded repository and run the following command:

```
chmod +x build.sh
```

This will make `build.sh` an executable. Now, we can easily build and run the project in the following way:

```
./build.sh -r
```

This can take a while, but the project should compile and you should see a window that looks somewhat like this.

![Default Window](docs/img/basic_scene.png)

Follow the tutorials in the [documentation](https://fszewczyk.github.io/shkyera-engine/md_docs_tutorials_get_started.html) to learn more about Shkyera Engine capabilities.