Browse Source

Extracted links to end of text file

master
Christopher 8 years ago
parent
commit
7a49d105a0
  1. 2
      Docs/fungus_docs/about.md
  2. 27
      Docs/fungus_docs/download.md
  3. 175
      Docs/fungus_docs/getting_started.md
  4. 2
      Docs/fungus_docs/tutorial_videos.md

2
Docs/fungus_docs/about.md

@ -22,11 +22,9 @@ The Fungus community is very welcoming and helpful to newcomers. Many people usi
## Features ## Features
@htmlonly @htmlonly
<div align="center" style="float:right;"> <div align="center" style="float:right;">
<iframe width="400" height="225" src="https://youtube.com/embed/kP767dFQaCU?t=5m20s" frameborder="0" allowfullscreen></iframe> <iframe width="400" height="225" src="https://youtube.com/embed/kP767dFQaCU?t=5m20s" frameborder="0" allowfullscreen></iframe>
</div> </div>
@endhtmlonly @endhtmlonly
Fungus allows you to easily add storytelling features to your Unity games with no coding, via an intuitive visual scripting system. Fungus allows you to easily add storytelling features to your Unity games with no coding, via an intuitive visual scripting system.

27
Docs/fungus_docs/download.md

@ -4,26 +4,30 @@ This page desribes how to download and install Unity and Fungus.
# Video Tutorial # Video Tutorial
@htmlonly
<div align="center">
<iframe width="560" height="315" src="https://www.youtube.com/embed/BQRdRz9Q5VY" frameborder="0" allowfullscreen></iframe> <iframe width="560" height="315" src="https://www.youtube.com/embed/BQRdRz9Q5VY" frameborder="0" allowfullscreen></iframe>
</div>
@endhtmlonly
# How do I install Fungus? # How do I install Fungus?
1. Install the latest version of [Unity](http://unity3D.com/get-unity). 1. Install the latest version of [Unity].
3. Launch Unity and create a new Project by selecting File > New Project. 3. Launch Unity and create a new Project by selecting File > New Project.
4. Select 'Use Defaults for 2D' when creating the new project. 4. Select 'Use Defaults for 2D' when creating the new project.
To install Fungus from the Asset Store (recommended): ## To install Fungus from the Asset Store (recommended):
1. Open the Asset Store window in Unity 1. Open the Asset Store window in Unity
2. Search for Fungus, or use [this link](http://u3d.as/f0T) 2. Search for Fungus on the [Asset Store]
3. Download and import Fungus to your project using the Asset Store window. 3. Download and import Fungus to your project using the Asset Store window.
To install Fungus from the latest release on Github: ## To install Fungus from the latest release on Github:
1. Download the latest Fungus .unitypackage from [Github](https://github.com/FungusGames/Fungus/releases/latest) 1. Download the latest Fungus .unitypackage from [Github]
2. Import Fungus into the new project by selecting Assets > Import Package > Custom Package. 2. Import Fungus into the new project by selecting Assets > Import Package > Custom Package.
First steps: # First steps
1. Display the Flowchart editor window by selecting Window > Tools > Fungus > Flowchart Window. 1. Display the Flowchart editor window by selecting Window > Tools > Fungus > Flowchart Window.
2. For convenience, you should dock the Flowchart window somewhere in the editor window. 2. For convenience, you should dock the Flowchart window somewhere in the editor window.
@ -37,7 +41,7 @@ Try playing the other example scenes and watch how the gameplay is controlled by
To upgrade an existing project to the latest version of Fungus. To upgrade an existing project to the latest version of Fungus.
1. Take a backup of your project. No really, do it! 1. Take a backup of your project. No really, do it!
2. We recommend updating to the latest version of [Unity](http://unity3D.com/get-unity). 2. We recommend updating to the latest version of [Unity].
3. Delete the Fungus and FungusExamples folders from your project. 3. Delete the Fungus and FungusExamples folders from your project.
4. Download and import the latest version of Fungus. 4. Download and import the latest version of Fungus.
@ -45,8 +49,13 @@ We try to maintain backwards compatibility between releases but sometimes breaki
# Fungus System Requirements # Fungus System Requirements
- We recommend installing the latest version of Unity 3D. - We recommend installing the latest version of [Unity].
- Fungus requires at least Unity 5.0 and is not compatible with Unity 4.x or earlier. - Fungus requires at least Unity 5.0 and is not compatible with Unity 4.x or earlier.
- Fungus works with both the PC & Mac versions of Unity - Fungus works with both the PC & Mac versions of Unity
- Fungus works with both the free Personal and Professional editions of Unity - Fungus works with both the free Personal and Professional editions of Unity
- Official Unity list of system requirements [available here](http://unity3d.com/unity/system-requirements). - Official Unity list of [system requirements].
[Unity]: http://unity3D.com/get-unity
[Asset Store]: http://u3d.as/f0T
[Github]: https://github.com/FungusGames/Fungus/releases/latest
[system requirements]: http://unity3d.com/unity/system-requirements

175
Docs/fungus_docs/getting_started.md

@ -7,56 +7,46 @@ Follow these steps to get up and running with Fungus quickly, then learn more ab
You'll need the Fungus Flowchart window when working with Fungus. Open and dock this window somewhere handy by following these steps: You'll need the Fungus Flowchart window when working with Fungus. Open and dock this window somewhere handy by following these steps:
1. Choose menu: ``Tools | Fungus | Flowchart Window`` 1. Choose menu: ``Tools | Fungus | Flowchart Window``
<br>
![Menu open Fungus window](./images/002_docking/1_menu.png "Menu open Fungus window") ![Menu open Fungus window]
<br>
<br>
2. Drag-and-drop the Flowchart window to the location you wish to dock it: 2. Drag-and-drop the Flowchart window to the location you wish to dock it:
<br>
![Drag Fungus window](./images/002_docking/2_window.png "Drag Fungus window") ![Drag Fungus window]
<br>
<br>
3. The Flowchart window is now docked and part of your Unity window layout: 3. The Flowchart window is now docked and part of your Unity window layout:
<br>
![Docked Fungus window](./images/002_docking/3_docked.png "Docked Fungus window") ![Docked Fungus window]
<!-- **************************************************** --> <!-- **************************************************** -->
## Finding the example folders and scene files ## Finding the example folders and scene files
Two folders are created when you install Fungus, the Fungus features themslves (in folder 'Fungus') and a set of examples (in folder 'FungusExamples'). Two folders are created when you install Fungus, the Fungus features themslves (in folder 'Fungus') and a set of examples (in folder 'FungusExamples').
Examples include Drag and Drop, Sherlock and Fungus Town: Examples include Drag and Drop, Sherlock and Fungus Town:
<br>
![Fungus Examples](./images/004_examples/1_examples.png "Fungus Examples") ![Fungus Examples]
<br>
You can use the left-hand side of the Unity Project window to explore each example folder: You can use the left-hand side of the Unity Project window to explore each example folder:
<br>
![Fungus Examples Project window](./images/004_examples/3_project_window.png "Fungus Examples Project window") ![Fungus Examples Project window]
<br>
Alternatively, you can 'filter' the Project view to show all scenes (and no other files) by clicking the scene filter icon to the right of the search bar: Alternatively, you can 'filter' the Project view to show all scenes (and no other files) by clicking the scene filter icon to the right of the search bar:
<br>
![Fungus Examples Project window filter scenes](./images/004_examples/2_filter_scenes.png "Fungus Examples Project window filter scenes") ![Fungus Examples Project window filter scenes]
<br>
You can cancel the filter by clicking the 'x' in the search bar: You can cancel the filter by clicking the 'x' in the search bar:
<br>
![Fungus Examples Project window filter scenes cancel](./images/004_examples/4_filter_scenes_cancel.png "Fungus Examples Project window filter scenes cancel") ![Fungus Examples Project window filter scenes cancel]
<br>
<!-- **************************************************** --> <!-- **************************************************** -->
## Loading and playing the example scenes ## Loading and playing the example scenes
To **load** an example scene, double click the desired example's scene object in the Project window, and the scene should load. For example, this screenshot shows the scene and Flowchart windows when the DragAndDrop example scene has been loaded: To **load** an example scene, double click the desired example's scene object in the Project window, and the scene should load. For example, this screenshot shows the scene and Flowchart windows when the DragAndDrop example scene has been loaded:
<br>
![Fungus Examples Drag Drop](./images/004_examples/5_drag_drop.png "Fungus Examples Drag Drop") ![Fungus Examples Drag Drop]
<br>
To **run** the currently loaded scene (i.e. to enter **Play-mode**), click the Unity 'play' triangle button at the center top of the Unity application window, and then do whatever makes sense in that scene (e..g click/type text/drag-and-drop objects etc.!): To **run** the currently loaded scene (i.e. to enter **Play-mode**), click the Unity 'play' triangle button at the center top of the Unity application window, and then do whatever makes sense in that scene (e..g click/type text/drag-and-drop objects etc.!):
<br>
![Unity play scene](./images/004_examples/6_drag_running.png "Unity play scene") ![Unity play scene]
<br>
Note: you click the 'play' button a second time to end **Play-mode**. Note: you click the 'play' button a second time to end **Play-mode**.
@ -75,17 +65,14 @@ Sometimes we can forget we are in Unity **Play-mode**, and then make changes to
1. Open the Unity preferences dialog by choosing menu: ```File | Preferences ...``` 1. Open the Unity preferences dialog by choosing menu: ```File | Preferences ...```
2. Select the ```Colors``` preferences, and choose a light colored tint (we chose a light green in this case): 2. Select the ```Colors``` preferences, and choose a light colored tint (we chose a light green in this case):
<br>
![Unity preferences dialog](./images/005_highlight_play_mode/1_prefs_tint.png "Unity preferences dialog") ![Unity preferences dialog]
<br>
<br>
3. Close the dialog (changes are saved automatically). 3. Close the dialog (changes are saved automatically).
4. When you next enter **Play-mode** you'll see most of the Unity Editor windows turn green (apart from the Game and Flowchart windows): 4. When you next enter **Play-mode** you'll see most of the Unity Editor windows turn green (apart from the Game and Flowchart windows):
<br>
![Unity Play Mode tinted](./images/005_highlight_play_mode/2_green_play_mode.png "Unity Play Mode tinted") ![Unity Play Mode tinted]
<br>
<!-- **************************************************** --> <!-- **************************************************** -->
## Creating, naming and saving a new scene from scratch ## Creating, naming and saving a new scene from scratch
@ -96,70 +83,56 @@ To create a new scene in Unity do the following:
2. Note: if you have any unsaved changes for the current scene you need to either save or abandon them before a new scene can be created. 2. Note: if you have any unsaved changes for the current scene you need to either save or abandon them before a new scene can be created.
3. You should now have a shiny new scene, with a Hierarchy containing just one gameObject, a Main Camera. The new scene will have been give the default name "Untitled", which you can see in the title of the Application window: 3. You should now have a shiny new scene, with a Hierarchy containing just one gameObject, a Main Camera. The new scene will have been give the default name "Untitled", which you can see in the title of the Application window:
<br>
![New Scene](./images/006_new_scene/1_default.png "New Scene") ![New Scene]
<br>
<br>
4. Good practice is to save your scene (in the right place, with the right name), before creating your work in the scene. Let's save this scene in the root of our project "Assets" folder, naming it "demo1". First choose menu: ```File | Save Scene As...``` 4. Good practice is to save your scene (in the right place, with the right name), before creating your work in the scene. Let's save this scene in the root of our project "Assets" folder, naming it "demo1". First choose menu: ```File | Save Scene As...```
5. Choose the location and name (we'll choose folders "Assets" and scene name "demo1"): 5. Choose the location and name (we'll choose folders "Assets" and scene name "demo1"):
<br>
![Save Scene As dialog](./images/006_new_scene/2_save_as.png "Save Scene As dialog") ![Save Scene As dialog]
<br>
<br>
6. Once you have successfully saved the scene you should now see the new scene file "demo1" in your Assets folder in the Project window, and you should also see in the Application window title that you are currently editing the scene named "demo1": 6. Once you have successfully saved the scene you should now see the new scene file "demo1" in your Assets folder in the Project window, and you should also see in the Application window title that you are currently editing the scene named "demo1":
<br>
![Editing newly saved scene](./images/006_new_scene/3_saved_scene.png "Editing newly saved scene") ![Editing newly saved scene]
<br>
<!-- **************************************************** --> <!-- **************************************************** -->
## Menu: Tools | Fungus ## Menu: Tools | Fungus
The core Fungus operations are available from the Unity ```Tools``` menu. The core Fungus operations are available from the Unity ```Tools``` menu.
Choose menu: ```Tools | Fungus``` to see the options available: Choose menu: ```Tools | Fungus``` to see the options available:
<br>
![Fungus Tools menu](./images/007_tools_menu/3_fungus_tools.png "Fungus Tools menu") ![Fungus Tools menu]
<br>
As can be seen, there are 2 submenus, ```Create``` and ```Utilities```, plus the ```Flowchart Window``` action (which reveals the window if already open, or opens a new window if the Flowchart window was not previously opened). As can be seen, there are 2 submenus, ```Create``` and ```Utilities```, plus the ```Flowchart Window``` action (which reveals the window if already open, or opens a new window if the Flowchart window was not previously opened).
<!-- *********** --> <!-- *********** -->
### Menu: Tools | Fungus | Create ### Menu: Tools | Fungus | Create
The Fungus Tools ```Create``` submenu offers the following actions: The Fungus Tools ```Create``` submenu offers the following actions:
<br>
![Fungus Tools Create menu](./images/007_tools_menu/1_tools_create.png "Fungus Tools Create menu") ![Fungus Tools Create menu]
<br>
<!-- *********** --> <!-- *********** -->
### Menu: Tools | Fungus | Utilities ### Menu: Tools | Fungus | Utilities
The Fungus Tools ```Utilties``` submenu offers the following actions: The Fungus Tools ```Utilties``` submenu offers the following actions:
<br>
![Fungus Tools Utilties menu](./images/007_tools_menu/2_tools_utilities.png "Fungus Tools Utilities menu") ![Fungus Tools Utilties menu]
<br>
<!-- **************************************************** --> <!-- **************************************************** -->
## Create a Flowchart ## Create a Flowchart
To create a Fungus Flowchart do the following: To create a Fungus Flowchart do the following:
1. Choose menu: ```Tools | Fungus | Create Flowchart``` 1. Choose menu: ```Tools | Fungus | Create Flowchart```
<br>
![menu create Flowchart](./images/008_create_flowchart/1_tools_create.png "menu create Flowchart") ![menu create Flowchart]
<br>
<br>
2. A new **Flowchart** gameObject should appear in the Hierarchy window. 2. A new **Flowchart** gameObject should appear in the Hierarchy window.
<br>
![new Flowchart gameobject](./images/008_create_flowchart/2_flowchart_gameobject.png "new Flowchart gameobject") ![new Flowchart gameobject]
<br>
<br>
3. Select the **Flowchart** gameObject in the Hierarchy window, and you'll see the **Flowchart's** properties in the Inspector Window: 3. Select the **Flowchart** gameObject in the Hierarchy window, and you'll see the **Flowchart's** properties in the Inspector Window:
<br>
![Flowchart properties](./images/008_create_flowchart/3_flowchart_properties.png "Flowchart properties") ![Flowchart properties]
<br>
<br>
4. If you have not already displayed the Flowchart Window, you can do so by clicking the Flowchart Window button in the Inspector. 4. If you have not already displayed the Flowchart Window, you can do so by clicking the Flowchart Window button in the Inspector.
@ -174,9 +147,8 @@ Let's change the name of the default command Block of a new Flowchart in the Flo
2. Click to select the Block in the Flowchart window (when multiple blocks are present, the selected one gets a green highlight border). 2. Click to select the Block in the Flowchart window (when multiple blocks are present, the selected one gets a green highlight border).
3. In the Inspector change the text for the Block Name property to "hello". You should see the Block name change in the Flowchart window: 3. In the Inspector change the text for the Block Name property to "hello". You should see the Block name change in the Flowchart window:
<br>
![rename Block](./images/009_rename_block/1_rename.png "rename Block") ![rename Block]
<br>
<!-- **************************************************** --> <!-- **************************************************** -->
## Add a Say command ## Add a Say command
@ -184,35 +156,48 @@ To add a "Say" command to a Block do the following:
1. (setup) Create a new scene, add a Fungus Flowchart to the scene. 1. (setup) Create a new scene, add a Fungus Flowchart to the scene.
1. Ensure the Block is selected, and you can see its properties in the Inspector, and ensure the name of the Block is "hello". 2. Ensure the Block is selected, and you can see its properties in the Inspector, and ensure the name of the Block is "hello".
3. Click the Plus button in the bottom half of the Inspector window, to add a new Command to the Block's properties:
![new command button]
4. Choose menu: ```Narrative | Say```:
2. Click the Plus button in the bottom half of the Inspector window, to add a new Command to the Block's properties: ![add Say command]
<br>
![new command button](./images/010_say_command/1_plus.png "new command button")
<br>
<br>
3. Choose menu: ```Narrative | Say```: 5. Since this Block only has one Command, that command is automatically selected (shown with a green highlight).
<br>
![add Say command](./images/010_say_command/2_narrative_say.png "add Say command")
<br>
<br>
4. Since this Block only has one Command, that command is automatically selected (shown with a green highlight). 6. In the "Story Text" textbox in the bottom half of the Inspector window type in "hello Fugus world":
5. In the "Story Text" textbox in the bottom half of the Inspector window type in "hello Fugus world": ![story text]
<br>
![story text](./images/010_say_command/3_hello_fungus_world.png "story text")
<br>
<br>
6. Run the scene, and see Fungus create a dialog window, and output the text contents of your Say command: 7. Run the scene, and see Fungus create a dialog window, and output the text contents of your Say command:
<br>
![story text output](./images/010_say_command/4_scene_running.png "story text output")
<br>
<br>
![story text output]
[Unity3D.com]: http://www.unity3d.com [Menu open Fungus window]: ./getting_started/002_docking/1_menu.png "Menu open Fungus window"
[Unity3D.com/get-unity]: http://unity3d.com/get-unity [Drag Fungus window]: ./getting_started/002_docking/2_window.png "Drag Fungus window"
[FungusGames.com]: http://www.fungusgames.com [Docked Fungus window]: ./getting_started/002_docking/3_docked.png "Docked Fungus window"
[Fungus Examples]: ./getting_started/004_examples/1_examples.png "Fungus Examples"
[Fungus Examples Project window]: ./getting_started/004_examples/3_project_window.png "Fungus Examples Project window"
[Fungus Examples Project window filter scenes]: ./getting_started/004_examples/2_filter_scenes.png "Fungus Examples Project window filter scenes"
[Fungus Examples Project window filter scenes cancel]: ./getting_started/004_examples/4_filter_scenes_cancel.png "Fungus Examples Project window filter scenes cancel"
[Fungus Examples Drag Drop]: ./getting_started/004_examples/5_drag_drop.png "Fungus Examples Drag Drop"
[Unity play scene]: ./getting_started/004_examples/6_drag_running.png "Unity play scene"
[Unity preferences dialog]: ./getting_started/005_highlight_play_mode/1_prefs_tint.png "Unity preferences dialog"
[Unity Play Mode tinted]: ./getting_started/005_highlight_play_mode/2_green_play_mode.png "Unity Play Mode tinted"
[New Scene]: ./getting_started/006_new_scene/1_default.png "New Scene"
[Save Scene As dialog]: ./getting_started/006_new_scene/2_save_as.png "Save Scene As dialog"
[Editing newly saved scene]: ./getting_started/006_new_scene/3_saved_scene.png "Editing newly saved scene"
[Fungus Tools menu]: ./getting_started/007_tools_menu/3_fungus_tools.png "Fungus Tools menu"
[Fungus Tools Create menu]: ./getting_started/007_tools_menu/1_tools_create.png "Fungus Tools Create menu"
[Fungus Tools Utilties menu]: ./getting_started/007_tools_menu/2_tools_utilities.png "Fungus Tools Utilities menu"
[menu create Flowchart]: ./getting_started/008_create_flowchart/1_tools_create.png "menu create Flowchart"
[new Flowchart gameobject]: ./getting_started/008_create_flowchart/2_flowchart_gameobject.png "new Flowchart gameobject"
[Flowchart properties]: ./getting_started/008_create_flowchart/3_flowchart_properties.png "Flowchart properties"
[rename Block]: ./getting_started/009_rename_block/1_rename.png "rename Block"
[new command button]: ./getting_started/010_say_command/1_plus.png "new command button"
[add Say command]: ./getting_started/010_say_command/2_narrative_say.png "add Say command"
[story text]: ./getting_started/010_say_command/3_hello_fungus_world.png "story text"
[story text output]: ./getting_started/010_say_command/4_scene_running.png "story text output"

2
Docs/fungus_docs/tutorial_videos.md

@ -3,11 +3,9 @@
These free tutorial videos cover most of the functionality available in Fungus. Many thanks to [Paul Mc Grath](http://whackala.com) for contributing the videos, and [Eric Chen](https://twitter.com/Eric_hjk) for Chinese subtitles. These free tutorial videos cover most of the functionality available in Fungus. Many thanks to [Paul Mc Grath](http://whackala.com) for contributing the videos, and [Eric Chen](https://twitter.com/Eric_hjk) for Chinese subtitles.
@htmlonly @htmlonly
<div align="center" style="float:right;"> <div align="center" style="float:right;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/F1vmEtQ7k6M?list=PLiMlyObJfJmUohJ_M2pJhtrNKuNECo2Uk" frameborder="0" allowfullscreen></iframe> <iframe width="560" height="315" src="https://www.youtube.com/embed/F1vmEtQ7k6M?list=PLiMlyObJfJmUohJ_M2pJhtrNKuNECo2Uk" frameborder="0" allowfullscreen></iframe>
</div> </div>
@endhtmlonly @endhtmlonly
* [Fungus Overview] * [Fungus Overview]

Loading…
Cancel
Save