https://github.com/skyost/escapegamekit
EscapeGameKit is a package, entirely built using Flutter, that helps creating escape games.
https://github.com/skyost/escapegamekit
escape flutter game lib
Last synced: about 1 year ago
JSON representation
EscapeGameKit is a package, entirely built using Flutter, that helps creating escape games.
- Host: GitHub
- URL: https://github.com/skyost/escapegamekit
- Owner: Skyost
- License: mit
- Created: 2022-03-02T19:51:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T10:30:41.000Z (about 3 years ago)
- Last Synced: 2025-03-17T06:04:30.814Z (about 1 year ago)
- Topics: escape, flutter, game, lib
- Language: Dart
- Homepage: https://pub.dev/packages/escape_game_kit
- Size: 30.6 MB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🕵️♂️ EscapeGameKit
EscapeGameKit is a package, entirely built using Flutter, that helps creating
[escape games](https://en.wikipedia.org/wiki/Escape_the_room).
It is better suited for web and desktop platforms (Windows, Linux, macOS) but can totally
be used on mobile platforms as well !
## Examples
You'll find an example in the [`example`](https://github.com/Skyost/EscapeGameKit/tree/master/example)
directory. It's a little escape game called _ERROR 1980_ that I've created for my students. I've translated
it into English, so that you can try it [here](https://skyost.github.io/EscapeGameKit/).
More screenshots
Here's what I've created using this package :
* [Voyage à Cendlard](https://skyost.github.io/VoyageACendlard/).
* [Murder Mystery](https://skyost.github.io/MurderMystery/).
Please note that these escape games are in french.
## Getting started
Everything you need to get started with this library is available in the
[wiki](https://github.com/Skyost/EscapeGameKit/wiki).
## Caveats
The plugin is currently in beta. Here's the list of things we (me, and hopefully any contributor 😀)
need to work on before release :
* **Better support of hot reload**. Currently, escape games don't support hot reload.
* **Better support of Android and iOS platforms**.
The plugin is still untested on these platforms, but it should perfectly work. The only problem
we may encounter is with tooltips.
## Contributions
You have a lot of options to contribute to this project ! You can :
* [Fork it](https://github.com/Skyost/EscapeGameKit/fork) on Github.
* [Submit](https://github.com/Skyost/EscapeGameKit/issues/new/choose) a feature request or a bug report.
* [Donate](https://paypal.me/Skyost) to the developer.
Also if you've created something using this library, feel free to
[tell me about it](https://github.com/Skyost/EscapeGameKit/issues/new?assignees=Skyost&labels=creation&template=created_something.md&title=) !
I may create a showcase to expose all creations if this library eventually become popular.