Skip to content

Commit

Permalink
Initial release of FungusLua documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@chrisgregan
chrisgregan committed May 11, 2016
1 parent f61aa50 commit 4cbd85b
Show file tree
Hide file tree
Showing 47 changed files with 8,757 additions and 80 deletions.
89 changes: 88 additions & 1 deletion about/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@


<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Fungus Docs <b class="caret"></b></a>
<ul class="dropdown-menu">


Expand Down Expand Up @@ -223,6 +223,93 @@



<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">FungusLua Docs <b class="caret"></b></a>
<ul class="dropdown-menu">


<li >
<a href="../fungus_lua/index.html">Overview</a>
</li>



<li >
<a href="../fungus_lua/create_menu/index.html">Create Menu</a>
</li>



<li >
<a href="../fungus_lua/lua_environment/index.html">Lua Environment</a>
</li>



<li >
<a href="../fungus_lua/lua_bindings/index.html">Lua Bindings</a>
</li>



<li >
<a href="../fungus_lua/lua_script/index.html">Lua Script</a>
</li>



<li >
<a href="../fungus_lua/lua_utils/index.html">Lua Utils</a>
</li>



<li >
<a href="../fungus_lua/fungus_module/index.html">Fungus Module</a>
</li>



<li >
<a href="../fungus_lua/controlling_fungus/index.html">Controlling Fungus</a>
</li>



<li >
<a href="../fungus_lua/execute_lua/index.html">ExecuteLua command</a>
</li>



<li >
<a href="../fungus_lua/preferences/index.html">Preferences</a>
</li>



<li >
<a href="../fungus_lua/lua_store/index.html">Lua Store</a>
</li>



<li >
<a href="../fungus_lua/string_table/index.html">String Table</a>
</li>



<li >
<a href="../fungus_lua/unity_test_tools/index.html">Unity Test Tools</a>
</li>


</ul>
</li>



<li >
<a href="../tutorial_videos/index.html">Tutorial Videos</a>
</li>
Expand Down
144 changes: 112 additions & 32 deletions advanced/narrative_parser_tokens/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@


<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Fungus Docs <b class="caret"></b></a>
<ul class="dropdown-menu">


Expand Down Expand Up @@ -223,6 +223,93 @@



<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">FungusLua Docs <b class="caret"></b></a>
<ul class="dropdown-menu">


<li >
<a href="../../fungus_lua/index.html">Overview</a>
</li>



<li >
<a href="../../fungus_lua/create_menu/index.html">Create Menu</a>
</li>



<li >
<a href="../../fungus_lua/lua_environment/index.html">Lua Environment</a>
</li>



<li >
<a href="../../fungus_lua/lua_bindings/index.html">Lua Bindings</a>
</li>



<li >
<a href="../../fungus_lua/lua_script/index.html">Lua Script</a>
</li>



<li >
<a href="../../fungus_lua/lua_utils/index.html">Lua Utils</a>
</li>



<li >
<a href="../../fungus_lua/fungus_module/index.html">Fungus Module</a>
</li>



<li >
<a href="../../fungus_lua/controlling_fungus/index.html">Controlling Fungus</a>
</li>



<li >
<a href="../../fungus_lua/execute_lua/index.html">ExecuteLua command</a>
</li>



<li >
<a href="../../fungus_lua/preferences/index.html">Preferences</a>
</li>



<li >
<a href="../../fungus_lua/lua_store/index.html">Lua Store</a>
</li>



<li >
<a href="../../fungus_lua/string_table/index.html">String Table</a>
</li>



<li >
<a href="../../fungus_lua/unity_test_tools/index.html">Unity Test Tools</a>
</li>


</ul>
</li>



<li >
<a href="../../tutorial_videos/index.html">Tutorial Videos</a>
</li>
Expand Down Expand Up @@ -253,7 +340,7 @@
</a>
</li>
<li >
<a rel="prev" href="../../tutorial_videos/index.html">
<a rel="prev" href="../../fungus_lua/index.html">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
Expand All @@ -268,44 +355,37 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">

<li class="main active"><a href="#fungus-advanced-narrative-parser-tokens-reference">Fungus Advanced - Narrative Parser Tokens Reference</a></li>
<li class="main active"><a href="#narrative-parser-tags">Narrative Parser Tags</a></li>


</ul>
</div></div>
<div class="col-md-9" role="main">

<h1 id="fungus-advanced-narrative-parser-tokens-reference">Fungus Advanced - Narrative Parser Tokens Reference</h1>
<h1 id="narrative-parser-tags">Narrative Parser Tags</h1>
<p>The following tokens can be used within Story Text to do things such as change the styling of text or clear the contents of a dialog area on input and much more.</p>
<ul>
<li>{b} - Bold start</li>
<li>{/b} - Bold end</li>
<li>{i} - Italic start</li>
<li>{/i} - Italic end</li>
<li>{color=red} - Color start</li>
<li>{/color} - Color end</li>
<li>{w} - Wait</li>
<li>{w=0.5} - Wait for a certain amount of time</li>
<li>{wi} - Wait for input, but do not clear the dialog area</li>
<li>{wc} - Wait for input, clear the dialog area after input</li>
<li>{wp} - Wait on punctutation start</li>
<li>{wp=0.5} - Wait on punctutation (after a certain amount of time) start</li>
<li>{/wp} - Wait on punctuation end</li>
<li>{c} - Clear the dialog area</li>
<li>{s} - Speed start</li>
<li>{s=60} - Speed (with speed setting) start</li>
<li>{/s} - Speed end</li>
<li>{x} - Exit</li>
<li>{m=MessageName} - Send a message with <code>MessageName</code></li>
<li>{vpunch=0.5} - Vertical punch</li>
<li>{hpunch=0.5} - Horizontal punch</li>
<li>{shake=0.5} - Shake</li>
<li>{shiver=0.5} - Shiver</li>
<li>{flash=0.5} - Flash</li>
<li>{audio=Sound} - Audio start for <code>Sound</code></li>
<li>{audioloop=Sound} - Audio loop for <code>Sound</code></li>
<li>{audiopause=Sound} - Audio pause for <code>Sound</code></li>
<li>{audiostop=Sound} - Audio stop for <code>Sound</code></li>
<li>{b} Bold Text {/b}</li>
<li>{i} Italic Text {/i}</li>
<li>{color=red} Color Text (color){/color}</li>
<li>{size=30} Text size {/size}</li>
<li>{s}, {s=60} Writing speed (chars per sec){/s}</li>
<li>{w}, {w=0.5} Wait (seconds)</li>
<li>{wi} Wait for input</li>
<li>{wc} Wait for input and clear</li>
<li>{wp}, {wp=0.5} Wait on punctuation (seconds){/wp}</li>
<li>{c} Clear</li>
<li>{x} Exit, advance to the next command without waiting for input</li>
<li>{vpunch=10,0.5} Vertically punch screen (intensity,time)</li>
<li>{hpunch=10,0.5} Horizontally punch screen (intensity,time)</li>
<li>{punch=10,0.5} Punch screen (intensity,time)</li>
<li>{flash=0.5} Flash screen (duration)</li>
<li>{audio=AudioObjectName} Play Audio Once</li>
<li>{audioloop=AudioObjectName} Play Audio Loop</li>
<li>{audiopause=AudioObjectName} Pause Audio</li>
<li>{audiostop=AudioObjectName} Stop Audio</li>
<li>{m=MessageName} Broadcast message</li>
<li>{$VarName} Substitute variable</li>
</ul>
<p>Examples:</p>
<pre><code>This is a line of dialog.
Expand Down
92 changes: 90 additions & 2 deletions articles/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@


<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Fungus Docs <b class="caret"></b></a>
<ul class="dropdown-menu">


Expand Down Expand Up @@ -223,6 +223,93 @@



<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">FungusLua Docs <b class="caret"></b></a>
<ul class="dropdown-menu">


<li >
<a href="../fungus_lua/index.html">Overview</a>
</li>



<li >
<a href="../fungus_lua/create_menu/index.html">Create Menu</a>
</li>



<li >
<a href="../fungus_lua/lua_environment/index.html">Lua Environment</a>
</li>



<li >
<a href="../fungus_lua/lua_bindings/index.html">Lua Bindings</a>
</li>



<li >
<a href="../fungus_lua/lua_script/index.html">Lua Script</a>
</li>



<li >
<a href="../fungus_lua/lua_utils/index.html">Lua Utils</a>
</li>



<li >
<a href="../fungus_lua/fungus_module/index.html">Fungus Module</a>
</li>



<li >
<a href="../fungus_lua/controlling_fungus/index.html">Controlling Fungus</a>
</li>



<li >
<a href="../fungus_lua/execute_lua/index.html">ExecuteLua command</a>
</li>



<li >
<a href="../fungus_lua/preferences/index.html">Preferences</a>
</li>



<li >
<a href="../fungus_lua/lua_store/index.html">Lua Store</a>
</li>



<li >
<a href="../fungus_lua/string_table/index.html">String Table</a>
</li>



<li >
<a href="../fungus_lua/unity_test_tools/index.html">Unity Test Tools</a>
</li>


</ul>
</li>



<li >
<a href="../tutorial_videos/index.html">Tutorial Videos</a>
</li>
Expand Down Expand Up @@ -300,7 +387,8 @@ <h2 id="david-sherlock">David Sherlock</h2>
<h2 id="leah-lee">Leah Lee</h2>
<p><a href="http://leahlee.studio">http://leahlee.studio</a></p>
<ul>
<li><a href="http://leahlee.studio/fungus-research-week-1">Fungus Research Week 1</a></li>
<li><a href="http://leahlee.studio/fungus-research-week-1">Fungus Research</a></li>
<li><a href="http://leahlee.studio/contributing-to-fungus-for-unity-week-2/">Contributing to Fungus</a></li>
</ul>
<h2 id="konrad-gadzina">Konrad Gadzina</h2>
<ul>
Expand Down
Loading

0 comments on commit 4cbd85b

Please sign in to comment.