Ineka is a small and customizable game engine made as a passion project to learn more about game and web development.
This project tries to make things its own way by proposing a graph based structure instead of a traditional ECS.
I prefer to warn you that this project was made for personal use but nothing is stopping you from using it or contributing.
Getting started
CLI installation
The simplest way to create a game project for Ineka is by using:
npx @ineka/create-game <name>
If you have npm 6+ you can also use:
npm init @ineka/game <name>
# Or
npm create @ineka/game <name>
You can find the cli package sources here.
Manual installation
You can also install the package using a package manager:
npm install @ineka/engine
Then use a bundler like webpack, rollup or parcel to bundle your game.
Packages
Ineka, by design, ships with a very minimal set of features. The goal is to offer an ecosystem of packages to customize the engine with features you want and need instead of imposing them.
This concept aims to reduce bloat and offer a large panel of customization options.
Find more about available packages here
CI/CD Workflows
This project uses GitHub Actions for CI/CD jobs.
We have workflows to:
- Build and test the project on each pull request.
- Build, test and release the project.
- Generate a documentation and deploy it.
Contributing
Any help and contribution is welcome, feel free to submit issues and/or contribute to the project.
Please read through the contributing guidelines for more details.
License
Copyright (c) 2021 Colin Espinas.
Ineka is distributed under the MIT License. See the license for more details.