README.md

Capsian Engine

Capsian is a weird, incomplete and performant Python game engine. The project was initially named "KeyFire Engine" but was later renamed to Capsian due to trademark related issues.

Report Bug || Request Feature

Table of Contents

• About the Project
  • Built With
  • Scripting
• Getting Started
  • Requirements
• License
• Acknowledgements

Performance

Capsian performs quite well, especially when you consider Python's notorious performance issues. In terms of framerate, batched scenes tend to hover around 1000 - 4000 FPS depending on the resolution, while more dynamic scenes can be a bit harder on the CPU, leading to poor performance.

Built With

• Python
• OpenGL
• Pyglet

Scripting

Currently, Python is the only option for Capsian scripting. Scripts are organized in an Object-Oriented fashion, with "Script" classes, input handlers and "IndependentComponent" decorators. All Capsian scripts are handled as entity components, as such, they must be attached to an entity, either manually or automatically via the already mentioned "IndependentComponent" decorator. The Capsian Script Manager can help you set up scripts with little to no effort.

Requirements

• A Python installation (3.7.3 Recommended)
• An OpenGL-Compatible Graphics Card

You can install all dependencies using the prepare.py script.

License

Distributed under the Apache license 2.0. See LICENSE for more information.

Acknowledgements

• Carpal ( for Capsianline )
• Liam ( for the README)
• lolloberga
• Pyglet ( for providing the amazing toolkit used to make Capsian possible )
• Myself