Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrlightful/unity-puzzlesystem-asset
The asset for the Unity Engine that allows to quickly create customisable puzzles.
https://github.com/mrlightful/unity-puzzlesystem-asset
framework modular puzzle puzzles tool unity unity-asset unity-editor unity-scripts unity3d
Last synced: 3 months ago
JSON representation
The asset for the Unity Engine that allows to quickly create customisable puzzles.
- Host: GitHub
- URL: https://github.com/mrlightful/unity-puzzlesystem-asset
- Owner: MrLightful
- Created: 2019-01-20T14:10:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-20T21:53:26.000Z (almost 6 years ago)
- Last Synced: 2024-10-10T10:41:01.118Z (3 months ago)
- Topics: framework, modular, puzzle, puzzles, tool, unity, unity-asset, unity-editor, unity-scripts, unity3d
- Language: C#
- Homepage: https://puzzlesystem.gitbook.io
- Size: 12.3 MB
- Stars: 23
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://paypal.me/sirokov)
# Unity Asset: Puzzle System
## Introduction
**Puzzle System** is a highly customizable framework for the projects that contain any kind of puzzles. The framework provides you with the set of common, but yet customizable, solutions; as well as the basic classes that can be used in order to create unique puzzle experiences.
## Table of contents
- [Install](#install)
- [Unity Asset Package](#unity-asset-package)
- [Clone Repository](#clone-repository)
- [Get Started](#get-started)
- [Puzzle Structure](#puzzle-structure)
- [Editor Utility](#editor-utility)
- [Full Documentation](#full-documentation)
- [Donation](#donation)
## Install
### Unity Asset Package
- Download [PuzzleSystem_v1.unitypackage](https://github.com/romatallinn/unity-puzzlesystem-asset/blob/master/PuzzleSystem_v1.unitypackage)
- Open Unity
- Menu -> Assets -> Import Package -> Custom Package
- Choose the downloaded package, click Open
### Clone Repository
```
// Clone this repository
$ git clone https://github.com/romatallinn/unity-puzzlesystem-asset.git
```
## Get Started
### Puzzle Structure
A very critical to understand in the beginning is how the puzzles will be structured in your project.
There are 3 types of elements for every puzzle:
- **Puzzle Handler** -- responsible for handling situations when the puzzle has been solved or failed. In other words, defines what actions will be taken on these critical events (e.g., solved puzzle -> open gates for the player).
- **Puzzle Logic** -- responsible for defining what kind of logic the puzzle is following; what player must accomplish in order to solve the puzzle, and what player's actions will lead to the failed condition (e.g., task: activate all triggers).
- **Puzzle Trigger** -- objects that the player will interact with in order to proceed with the puzzle (e.g., press a certain keyboard key in a dedicated zone). It should not contain any logic for puzzle solving. It can, however, contain the information for the Puzzle Logic, where it will be analyzed and the decision will then be given on whether or not this trigger helps to solve the puzzle.
### Editor Utility
There is an editor tool that you can make use of.
In order to open it:
`Menu -> Tools -> Puzzle System`
## Full Documentation
You can find an extensive documentation available online at
https://puzzlesystem.gitbook.io.
There you can read more thorough material on all of the aspects and features available in the framework, as well as examples and other tips.
## Donation
I know, this project isn't something huge, but I'm a just passionate student of Computer Science & Engineering that wants to conquer the world with his dev skills. A small tip for a cup of coffee, so I can code all days and nights, would be highly appreciated and really helpful!
[](https://paypal.me/sirokov)
## License
The MIT License (MIT) 2019 - [Roman Sirokov](https://flist.me/u/rsirokov). Please have a look at the [LICENSE.md]() for more details.