Multi-platform Adventure Game Engine
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
The original KiriKiri2 / KAG3 was a famous adventure game engine in Japan. The project had been closed, and no longer mantained. The successor project KiriKiriZ is live, but seems not mantained recently, and also it seems to be only for Japanese developer. Therefore, I have been creating this game engine from scratch.
- Run on electron framework. It means your game will run on multiple-platforms.
- Aiming to keep compatibility with KAG3.
- KiriKiri2 had a script interpleter named TJS. This project doesn't implement TJS, but uses Typescript for that purpose.
- MIT License. You can add your own code to this.
- But I would love you to pull-request, so that this original engine will be enriched.
To get a local copy up and running follow these simple example steps.
git clone [email protected]:yoshiomiyamae/fsgs.git
yarn- Put your game data into
datadirectory. As default, there is a sample data. - The entry point is
data/scenario/first.ks. Modify the file first to implement your game. - Test Run
yarn start- To compile your game to distribute, use these commands.
yarn build:win # For Windows
yanr build:linux # For LinuxFor more examples, please refer to the Documentation
See the Milestone for v1.0.0 for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Project Link: FSGS