diff --git a/Docs/forum/index.md b/Docs/forum/index.md deleted file mode 100644 index e9c44c4a..00000000 --- a/Docs/forum/index.md +++ /dev/null @@ -1,9 +0,0 @@ - -## Welcome -We aim to help everybody who's using Fungus, no matter what your experience level. If you're stuck just ask! - -## Code of conduct -We would ask that all users of the community forum respect our [code of conduct](../conduct/index.md). - -fungus - diff --git a/Docs/fungus_lua.md b/Docs/fungus_lua.md new file mode 100644 index 00000000..01361e0c --- /dev/null +++ b/Docs/fungus_lua.md @@ -0,0 +1,17 @@ +# Fungus Lua {#fungus_lua} + +FungusLua is a simple way to embed Lua scripting into your Unity project. Lua is an easy to learn scripting language so it's a great way to empower artists, writers and designers to use more of the power of Unity. + +* @subpage lua_overview +* @subpage lua_create_menu +* @subpage lua_environment +* @subpage lua_bindings +* @subpage lua_script +* @subpage lua_utils +* @subpage lua_fungus_module +* @subpage lua_controlling_fungus +* @subpage execute_lua +* @subpage lua_preferences +* @subpage lua_store +* @subpage lua_string_table +* @subpage lua_unity_test_tools diff --git a/Docs/fungus_lua/controlling_fungus.md b/Docs/fungus_lua/controlling_fungus.md index edee75d7..d3afb826 100644 --- a/Docs/fungus_lua/controlling_fungus.md +++ b/Docs/fungus_lua/controlling_fungus.md @@ -1,4 +1,4 @@ -# Controlling Fungus +# Controlling Fungus {#lua_controlling_fungus} The Fungus module provides several functions for working with the standard Fungus narrative features and flowcharts. diff --git a/Docs/fungus_lua/create_menu.md b/Docs/fungus_lua/create_menu.md index 264f7175..89695660 100644 --- a/Docs/fungus_lua/create_menu.md +++ b/Docs/fungus_lua/create_menu.md @@ -1,4 +1,4 @@ -# The Create Menu +# The Create Menu {#lua_create_menu} The easiest way to add Lua scripting to your scene is via the Tools > Fungus > Create menu. This allows you to quickly instantiate one of the Lua prefabs that comes with FungusLua. The FungusLua prefabs all begin with 'Lua'. diff --git a/Docs/fungus_lua/execute_lua.md b/Docs/fungus_lua/execute_lua.md index 2f045144..de3843d9 100644 --- a/Docs/fungus_lua/execute_lua.md +++ b/Docs/fungus_lua/execute_lua.md @@ -1,4 +1,4 @@ -# The ExecuteLua Command +# The ExecuteLua Command {#execute_lua} This command allows you to embed a Lua script to be executed as part of a command sequence in a Block. The Lua script to be executed can be specified in the inspector or in a text file, in the same way as in the [Lua Script component](lua_script.md#lua-script-and-files). diff --git a/Docs/fungus_lua/fungus_module.md b/Docs/fungus_lua/fungus_module.md index 410b7c42..97a978ac 100644 --- a/Docs/fungus_lua/fungus_module.md +++ b/Docs/fungus_lua/fungus_module.md @@ -1,4 +1,4 @@ -# Fungus Module +# Fungus Module {#lua_fungus_module} This Lua module provides handy functions for working with Lua, Unity and Fungus. diff --git a/Docs/fungus_lua/index.md b/Docs/fungus_lua/index.md index f85e4fa4..34fc4285 100644 --- a/Docs/fungus_lua/index.md +++ b/Docs/fungus_lua/index.md @@ -1,4 +1,4 @@ -# What is FungusLua? +# What is FungusLua? {#lua_overview} FungusLua is a simple way to embed Lua scripting into your Unity project. Lua is an easy to learn scripting language so it's a great way to empower artists, writers and designers to use more of the power of Unity. diff --git a/Docs/fungus_lua/lua_bindings.md b/Docs/fungus_lua/lua_bindings.md index 1a06c9b9..c6e98f31 100644 --- a/Docs/fungus_lua/lua_bindings.md +++ b/Docs/fungus_lua/lua_bindings.md @@ -1,4 +1,4 @@ -# LuaBindings component +# LuaBindings component {#lua_bindings} The LuaBindings component allows you map gameobjects and components in your scenes to Lua variables which you can then access in your Lua scripts. You can bind to any component, including standard Unity components, components from the Unity Asset Store and your own custom scripts. diff --git a/Docs/fungus_lua/lua_environment.md b/Docs/fungus_lua/lua_environment.md index 92c0903a..a840821a 100644 --- a/Docs/fungus_lua/lua_environment.md +++ b/Docs/fungus_lua/lua_environment.md @@ -1,4 +1,4 @@ -# LuaEnvironment +# LuaEnvironment {#lua_environment} The LuaEnvironment component manages all the variables, functions, executing code, etc. for a single Lua context, and provides handy functions for loading and running Lua scripts. In order to run Lua code there must be at least one LuaEnvironment component present in the scene. diff --git a/Docs/fungus_lua/lua_script.md b/Docs/fungus_lua/lua_script.md index b7ae5502..3856de08 100644 --- a/Docs/fungus_lua/lua_script.md +++ b/Docs/fungus_lua/lua_script.md @@ -1,4 +1,4 @@ -# LuaScript +# LuaScript {#lua_script} The LuaScript component provides an easy way to run Lua scripts in your scene. You can create a LuaScript object via (Tools > Fungus > Create > LuaScript). diff --git a/Docs/fungus_lua/lua_store.md b/Docs/fungus_lua/lua_store.md index 145e345b..b3aa2cba 100644 --- a/Docs/fungus_lua/lua_store.md +++ b/Docs/fungus_lua/lua_store.md @@ -1,4 +1,4 @@ -# LuaStore +# LuaStore {#lua_store} A common issue when working with multiple scenes in Unity is how to persist variable values from one scene to the next. By default, all scene objects and their properties are destroyed when you load another scene. diff --git a/Docs/fungus_lua/lua_utils.md b/Docs/fungus_lua/lua_utils.md index 36b19ac3..d6b90390 100644 --- a/Docs/fungus_lua/lua_utils.md +++ b/Docs/fungus_lua/lua_utils.md @@ -1,4 +1,4 @@ -# LuaUtils +# LuaUtils {#lua_utils} LuaUtils is a component that extends the Lua environment with some commonly used functionality. diff --git a/Docs/fungus_lua/preferences.md b/Docs/fungus_lua/preferences.md index a5c8d02f..13e04e21 100644 --- a/Docs/fungus_lua/preferences.md +++ b/Docs/fungus_lua/preferences.md @@ -1,4 +1,4 @@ -# PlayerPrefs +# PlayerPrefs {#lua_preferences} The [Unity PlayerPrefs](http://docs.unity3d.com/ScriptReference/PlayerPrefs.html) system stores and accesses player preferences between game sessions. diff --git a/Docs/fungus_lua/string_table.md b/Docs/fungus_lua/string_table.md index 152d414a..fc359cb4 100644 --- a/Docs/fungus_lua/string_table.md +++ b/Docs/fungus_lua/string_table.md @@ -1,4 +1,4 @@ -# String Table +# String Table {#lua_string_table} The LuaUtils component provides support for simple text localisation. diff --git a/Docs/fungus_lua/unity_test_tools.md b/Docs/fungus_lua/unity_test_tools.md index 8c7bccd0..e8f18513 100644 --- a/Docs/fungus_lua/unity_test_tools.md +++ b/Docs/fungus_lua/unity_test_tools.md @@ -1,4 +1,4 @@ -# Unity Test Tools +# Unity Test Tools {#lua_unity_test_tools} If you are using the [Unity Test Tools](http://u3d.as/65h), FungusLua is a powerful and fast way to create integration tests using Lua scripting. diff --git a/Docs/mainpage.md b/Docs/mainpage.md index 9da95e72..8022d4fc 100644 --- a/Docs/mainpage.md +++ b/Docs/mainpage.md @@ -1,4 +1,4 @@ -# Fungus Docs +# Fungus Documentation Welcome to the documentation website for Fungus, the open source visual storytelling tool for [Unity](http://unity3d.com). @@ -6,6 +6,7 @@ The main website for Fungus and [community forum](http://fungusgames.com/forum) * @subpage about * @subpage training_course +* @subpage tutorial_videos * @subpage download * @subpage getting_started * @subpage flowcharts