An easy to use Unity 3D library for creating illustrated Interactive Fiction games and more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

50 lines
2.8 KiB

11 years ago
Fungus
11 years ago
======
10 years ago
The goal of Fungus is to provide a free, open source tool for creating interactive storytelling games in Unity 3D. Fungus is designed to be easy to learn for beginners to Unity 3D, especially for people with no coding experience. For power users, it provides an intuitive, fast workflow for visual scripting and interactive storytelling. Fungus is being used to create Visual Novels, Point and Click Adventure Games, Childrens Stories, Hidden Object Games, eLearning apps and also some frankly weird stuff which defies classification :)
11 years ago
5 years ago
- Maintainer: [Steve Halliwell](https://github.com/stevehalliwell)
5 years ago
- Website: [fungusgames.com](https://fungusgames.com)
5 years ago
- Email: funguswork@stevehalliwell.com
5 years ago
Fungus was originally created by [Chris Gregan](https://github.com/chrisgregan) - [@gofungus](https://twitter.com/gofungus)
11 years ago
11 years ago
Installation
============
5 years ago
Download & installation instructions and tutorial videos are available in [the wiki](https://github.com/snozbot/fungus/wiki/installation) and the official [Fungus website](https://fungusgames.com).
11 years ago
4 years ago
Support & Documentation
11 years ago
=======
4 years ago
The Fungus documentation is available on [our wiki](https://github.com/snozbot/fungus/wiki). Contributions to the wiki are very welcome.
5 years ago
If you have questions about Fungus, please search our forum first as someone may have had the same issue already. If you can't find an answer please start a new discussion and we'll answer you as soon as we can. Fungus is designed for beginners and we love to hear from users so please don't be shy about posting on [the forum](https://fungusgames.com/forum)!
10 years ago
5 years ago
There is also a community run [Discord server](https://discord.gg/99RqraQ).
8 years ago
You can also join into our chat room.
[![Join the chat at https://gitter.im/snozbot/fungus](https://badges.gitter.im/snozbot/fungus.svg)](https://gitter.im/snozbot/fungus?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4 years ago
Status & Branches
=================
Fungus uses a [gitflow](https://nvie.com/posts/a-successful-git-branching-model/) style setup. The default branch holds the most recent stable release. Develop is the staging ground for ongoing work and the default target of most PRs.
Develop is currently the staging ground for the next Fungus [feature release 3.14](https://github.com/snozbot/fungus/milestone/1)
10 years ago
Contributing
============
5 years ago
Many thanks to everyone who has [contributed](https://github.com/snozbot/fungus/graphs/contributors) to the project to date!
5 years ago
To contribute code or documentation to Fungus, please see [CONTRIBUTING](https://github.com/snozbot/fungus/blob/master/CONTRIBUTING.md).
10 years ago
5 years ago
You can view the upcoming roadmap via the [Milestones](https://github.com/snozbot/fungus/milestones).
8 years ago
Running the automated tests
===========================
5 years ago
The Unity Test Runner is used for testing some underlying elements. Far more are desired and PRs in this area would most welcome.