Difference between revisions of "Manual"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(General Information...)
m (Text replacement - ""wikitable"" to ""ts"")
Line 3: Line 3:
  
 
== Introducing... ==
 
== Introducing... ==
{| class="wikitable" style="width:100%;"
+
{| class="ts" style="width:100%;"
 
|-
 
|-
 
| [[An_Introduction_to_Visionaire_Studio:_Adventure_Game_Engine|Visionaire Studio: Adventure Game Engine]]: What is Visionaire Studio all about?
 
| [[An_Introduction_to_Visionaire_Studio:_Adventure_Game_Engine|Visionaire Studio: Adventure Game Engine]]: What is Visionaire Studio all about?
Line 19: Line 19:
  
 
== A Quick Overview of... ==
 
== A Quick Overview of... ==
{| class="wikitable" style="width:100%;"
+
{| class="ts" style="width:100%;"
 
|-
 
|-
 
| [[Visionaire_Studio_Startup|the Startup Screen]]: The startup screen, which allows you to create a new project, open a previous or recently saved project etc.
 
| [[Visionaire_Studio_Startup|the Startup Screen]]: The startup screen, which allows you to create a new project, open a previous or recently saved project etc.
Line 53: Line 53:
  
 
== All About... ==
 
== All About... ==
{| class="wikitable" style="width:100%;"
+
{| class="ts" style="width:100%;"
 
|-
 
|-
 
| [[Action_System|Actions]]: A quick explanation of the action system & the various action types that are available.
 
| [[Action_System|Actions]]: A quick explanation of the action system & the various action types that are available.
Line 67: Line 67:
  
 
== How to... ==
 
== How to... ==
{| class="wikitable" style="width:100%;"
+
{| class="ts" style="width:100%;"
 
|-
 
|-
 
| Create a Game Menu:
 
| Create a Game Menu:
Line 83: Line 83:
  
 
== The Lua Corner ==
 
== The Lua Corner ==
{| class="wikitable" style="width:100%;"
+
{| class="ts" style="width:100%;"
 
|-
 
|-
 
| [[Scripting|Scripting]]: A quick guide to scripting in Visionaire Studio.
 
| [[Scripting|Scripting]]: A quick guide to scripting in Visionaire Studio.
Line 99: Line 99:
  
 
== A Few Tips... ==
 
== A Few Tips... ==
{| class="wikitable" style="width:100%;"
+
{| class="ts" style="width:100%;"
 
|-
 
|-
 
| [[Approaching_Sound_Design|on Sound Design]]: A few things to consider when approaching sound design & music production, for your game.
 
| [[Approaching_Sound_Design|on Sound Design]]: A few things to consider when approaching sound design & music production, for your game.

Revision as of 18:35, 19 August 2014

This is the official documentation for Visionaire Studio: Adventure Game Engine.
Please use the links below to navigate.

Introducing...

Visionaire Studio: Adventure Game Engine: What is Visionaire Studio all about?
the Visionaire Studio Team: Say hello to the people behind Visionaire Studio.

General Information...

License Options: Here are the available license plans for Visionaire Studio.
System Requirements: Minimum & recommended system requirements for Visionaire Studio.

A Quick Overview of...

the Startup Screen: The startup screen, which allows you to create a new project, open a previous or recently saved project etc.
the System Menu: The system menu of the Visionaire Studio editor.
the Developer Console: The developer/debug console that is available by pressing tab during a game launched via the Visionaire Studio Editor.
the Game tab: See Main Editor Tabs.
the Loading Screen tab: See Main Editor Tabs.
the Scenes and Menus tab: See Main Editor Tabs.
the Characters tab: See Main Editor Tabs.
the Interfaces tab: See Main Editor Tabs.
the Items tab: See Main Editor Tabs.
the Cursors tab: See Main Editor Tabs.
the Fonts tab: See Main Editor Tabs.
the Texts tab: See Main Editor Tabs.
the Particle Systems tab: See Main Editor Tabs.
the Scripts tab: See Main Editor Tabs.
Action Parts: A quick explanation of each action part.

All About...

Actions: A quick explanation of the action system & the various action types that are available.
Conditions & Values: What are conditions & values? How can we use them?
Control Interfaces: A quick rundown of control interface types & how to create them.
Displayed Text: What are the differences between Display text? Display Speaker Text? & Display Object Text?
Particles: What are particles? & how can we use them to enhance our games?

How to...

Create a Game Menu:
Create a Save Menu:
Build a Playable Scene:
Configure Your Characters:
Create Animations in Visionaire Studio:
Build Your Game: How to compile & export your game as an executable (.exe) file, ready for playing.

The Lua Corner

Scripting: A quick guide to scripting in Visionaire Studio.
Data Structure: A compiled list of scriptable & read only editor actions & options.
Player Commands: A list of Exclusive Lua functions for Visionaire Studio.
Common Commands: A list of Exclusive Lua commands for Visionaire Studio.
Basic Lua: An introduction to scripting in Lua; for the general layman.
Lua Script Index: A compiled list of shared Lua Scripts & examples made by various members of the Visionaire Studio team & community.

A Few Tips...

on Sound Design: A few things to consider when approaching sound design & music production, for your game.
on Video Encoding: Recommended video formats & a few tips on video encoding.

Main Editor Tabs

Game: This is where you can setup the main game properties: mouse, key input, languages, provide information & version build number etc
Loading Screen: You can create an incrementally loading splash screen here; to display on game start
Loading25.png
Scenes & Menus: This is where you can create, build & design your scenes, menus, objects & actions to be performed etc
Scene25.png
Characters: This is where you can create your characters, outfits & animations etc
Character25.png
Interfaces: This is where you can create your main game control interface & on screen interfaces; such as inventory etc
Interface25.png
Items: This is where you create items that can be picked up, stored in your inventory, given to other characters or combined with other objects
Item25.png
Cursors: This is where you create & animate mouse cursors you will be using throughout your game
Cursor25.png
Fonts: This is where you include the various fonts that will be used throughout your game in dialogs, displayed text & displaying object/character labels on mouse over
Font25.png
Texts: This is where you will find all texts for the game: labels, names, scripts, dialog etc & you can edit them via this section; if you like
Text25.png
Particle System: This is where you can create particles; like snow, rain, fog, fire etc (advanced users)
Particle25.png
Scripts: This is the LUA Script editor in which you can write or include (load) external library files such as lua or c languages (advanced users)
Script25.png