Christopher
8 years ago
20 changed files with 164 additions and 207 deletions
@ -1,58 +1,64 @@
|
||||
# Frequently Asked Questions {#faq} |
||||
# Frequently Asked Questions # {#faq} |
||||
[TOC] |
||||
|
||||
## What is %Fungus ? |
||||
# What is Fungus? # {#what_is_fungus} |
||||
%Fungus is a free open source tool for creating storytelling games, with a strong focus on accessibility for novice game developers. Users all over the world are now using it to create a wonderfully diverse range of storytelling games. |
||||
|
||||
## Who makes %Fungus ? |
||||
%Fungus is developed by [Snozbot](http://snozbot.com), a small independent games company. Chris Gregan is the main developer of %Fungus. |
||||
# Who makes Fungus? # {#who_makes} |
||||
%Fungus is developed by [Snozbot], a small independent games company. Chris Gregan is the main developer of %Fungus. |
||||
|
||||
## Where do I get %Fungus ? |
||||
%Fungus is available on the [Unity Asset Store](http://u3d.as/f0T) and in the download section of this website. |
||||
# Where do I get Fungus? # {#where_get} |
||||
%Fungus is available on the [Unity Asset Store] and in the download section of this website. |
||||
|
||||
## Is %Fungus really free to use? |
||||
# Is Fungus really free to use? # {#really_free} |
||||
Yes. %Fungus has an Open Source M.I.T. license. You can use %Fungus with any version of the Unity game engine, including the freely available personal edition. |
||||
|
||||
## Can I sell the apps I make with %Fungus ? |
||||
# Can I sell the apps I make with Fungus? # {#can_sell} |
||||
Yes. We do not charge a license fee. |
||||
|
||||
## What platforms does %Fungus support ? |
||||
# What platforms does Fungus support? # {#platforms} |
||||
%Fungus runs on any platform supported by the Unity game engine. See here for a list of supported platforms. |
||||
|
||||
## Do I need to be a programmer to use %Fungus ? |
||||
# Do I need to be a programmer to use Fungus? # {#non_coders} |
||||
No. %Fungus can be used to make a variety of story-driven games with no coding required. |
||||
|
||||
## Is %Fungus useful for programmers ? |
||||
# Is Fungus useful for programmers? # {#coders} |
||||
Yes. %Fungus provides an easy way to add visual novel features to any Unity game. It is also possible to extend %Fungus to customise the workflow for your team. Checkout the documentation and tutorials for more information. |
||||
|
||||
## Where can I learn more about %Fungus ? |
||||
# Where can I learn more about Fungus? # {#learn_more} |
||||
We provide extensive tutorials and documentation on our website here. There is also a comprehensive online training course suitable for beginners at Udemy. |
||||
|
||||
## I've made something cool with %Fungus. Wanna see? |
||||
# I've made something cool with Fungus. Wanna see? # {#show_and_tell} |
||||
Most definitely! Please tweet @gofungus and/or post an item in the announcements section of our forum. |
||||
|
||||
## How can I upload my %Fungus game for others to see? |
||||
After creating a build, you can use a hosting service such as [itch.io](http://itch.io), [gamejolt.com](http://gamejolt.com) or [newgrounds.com](http://newgrounds.com) |
||||
# How can I upload my Fungus game for others to see? # {#where_upload} |
||||
After creating a build, you can use a hosting service such as [itch.io], [gamejolt.com] or [newgrounds.com] |
||||
|
||||
## How can I suggest new features for %Fungus ? |
||||
Please use the forum to request new features. You can also checkout our github issues list to see what we have planned. |
||||
# How can I report a bug or suggest new features for Fungus? # {#bug_reports} |
||||
Please use the forum to report bugs and request new features. You can also checkout our github issues list to see what we have planned. |
||||
|
||||
## How do I report a bug in %Fungus? |
||||
Please use the forum to report bugs. |
||||
|
||||
## How long will I have to wait for a bug-fix ? |
||||
# How long will I have to wait for a bug-fix? # {#how_long} |
||||
If a bug is critical and we can't offer a sensible workaround, we will try to fix it as soon as possible. Otherwise, we will aim to fix the issue in the next release. |
||||
|
||||
## Can I get my hands on beta versions of %Fungus ? |
||||
The very latest version is always available at our [github repository](https://github.com/snozbot/fungus) |
||||
# Can I get my hands on beta versions of Fungus? # {#beta_version} |
||||
The very latest version is always available at our [github repository] |
||||
|
||||
## How can I contribute to %Fungus? |
||||
There are lots of ways to help the %Fungus community to grow |
||||
# How can I contribute to Fungus? # {#contribute} |
||||
There are lots of ways to help the %Fungus community to grow! |
||||
|
||||
1. Answer questions and post tips on the forum |
||||
2. Contribute code either via a Github pull request or post code snippets in the forums. |
||||
3. Improve the documentation by editing the [fungus-site repo](https://github.com/snozbot/fungus-site) and send in a pull request. |
||||
3. Improve the documentation by editing the Docs folder on github and send in a pull request. |
||||
4. Let us know on the forum if you've made a game with %Fungus so we can add it to the site. |
||||
5. If you write an article, blog post, podcast, etc. about %Fungus send it in and we'll add it to the [community articles](../articles/index.md) section. |
||||
|
||||
## Are you planning to integrate %Fungus into other game engines ? |
||||
Not currently. We're sticking with Unity for the foreseeable future. |
||||
5. If you write an article, blog post, podcast, etc. about %Fungus send it in and we'll add it to the [community articles] section. |
||||
|
||||
# Are you planning to integrate Fungus into other game engines? # {#other_engines} |
||||
Not currently. We're sticking with Unity for the foreseeable future. |
||||
|
||||
[Snozbot]: http://snozbot.com |
||||
[Unity Asset Store]: http://u3d.as/f0T |
||||
[itch.io]: http://itch.io |
||||
[gamejolt.com]: http://gamejolt.com |
||||
[newgrounds.com]: http://newgrounds.com |
||||
[github repository]: https://github.com/snozbot/fungus |
||||
[community articles]: ../articles/index.md |
@ -1,63 +0,0 @@
|
||||
# %Fungus Module {#lua_fungus_module} |
||||
|
||||
This Lua module provides handy functions for working with Lua, Unity and %Fungus. |
||||
|
||||
In this page we cover some of the more generic functionality in the module, other major features are described elsewhere in the documentation. |
||||
|
||||
# Inspecting Lua objects |
||||
|
||||
You can use Lua's built in print() function to get a basic description of any object printed to the console. When you want to get a more detailed description of an object, use inspect(). |
||||
|
||||
```lua |
||||
-- Prints a short description of object v |
||||
print(v) |
||||
|
||||
-- Prints a summary of object v in a human readable format. |
||||
inspect(v) |
||||
``` |
||||
|
||||
# Running Unity coroutines |
||||
|
||||
When you bind to a C# component using Lua Bindings, you can access any public method in the class. If a method returns IEnumerator then that method can be executed as a [Unity coroutine], which is a powerful way to run asynchronous code. |
||||
|
||||
The runwait() function allows you to call a C# coroutine method from Lua which may take multiple frames to finish its work, and then carry on with the rest of the Lua code once that C# method has finished executing. This is how the say() function works for example. |
||||
|
||||
This is the list of available functions for waiting and working with coroutines. |
||||
|
||||
|
||||
```lua |
||||
-- Waits for a number of seconds, then continue execution of Lua script |
||||
wait(duration) |
||||
|
||||
-- Waits until the Lua function provided returns true, or the timeout expires. |
||||
-- Returns true if the function succeeded, or false if the timeout expired |
||||
waitfor(fn, timeoutduration) |
||||
|
||||
-- Run a C# coroutine and continue execution of Lua script |
||||
run(co) |
||||
|
||||
-- Run a C# coroutine, wait until it completes, then continue execution of Lua script |
||||
runwait(co) |
||||
``` |
||||
|
||||
# Globals vs Table mode |
||||
|
||||
The %Fungus module can be used in three modes, controlled by the %Fungus Module option in the LuaUtils component. |
||||
|
||||
1. Use Global Variables: all module functions are mapped to global functions. This allows for convenient access, but it runs the risk that you might accidentally declare a variable with the same name as a %Fungus module function. |
||||
2. Use %Fungus Variable: all module functions are accessed through a global table called 'fungus'. This gives a degree of namespace safety at the cost of more typing. |
||||
3. No %Fungus Module: the %Fungus module will not be registered. Used if you don't want to use the %Fungus module. |
||||
|
||||
Options 1 and 2 are functionaly equivalent, it's just a matter of personal preference which you want to use. |
||||
|
||||
```lua |
||||
-- sub is a function in the %Fungus module, mapped to a global variable |
||||
|
||||
-- Use Global Variables |
||||
sub('a string') |
||||
|
||||
-- Use Fungus Variable |
||||
fungus.sub('a string') |
||||
``` |
||||
|
||||
[Unity coroutine]: http://docs.unity3d.com/Manual/Coroutines.html |
Loading…
Reference in new issue