Difference between revisions of "Manual"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(27 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
Please use the links below to navigate.
 
Please use the links below to navigate.
  
{| class="wikitable" style="width:100%;"
+
== Introducing... ==
 +
{| class="ts" style="width:100%;"
 
|-
 
|-
| '''Introducing...'''
+
| [[An_Introduction_to_Visionaire_Studio:_Adventure_Game_Engine|Visionaire Studio: Adventure Game Engine]]: What is Visionaire Studio all about?
 
|-
 
|-
| '''[[An_Introduction_to_Visionaire_Studio™|Visionaire Studio: Adventure Game Engine]]:''' What is Visionaire Studio all about?
+
| [[Meet_The_Team|the Visionaire Studio Team]]: Say hello to the people behind Visionaire Studio.
|-
 
| '''[[Meet_The_Team|the Visionaire Studio Team]]:''' Say hello to the people behind Visionaire Studio.
 
 
|}
 
|}
  
{| class="wikitable" style="width:100%;"
+
== General Information... ==
|-
+
{| class="ts" style="width:100%;"
| '''General Information...'''
 
|-
 
| License Options || Here are the available license plans for Visionaire Studio.
 
 
|-
 
|-
| Supported Platforms || A list of supported platforms for the editor & target platforms for export.
+
| [[Visionaire_Studio_Licenses|License Options]]: Here are the available license plans for Visionaire Studio.
 
|-
 
|-
| System Requirements || Recommended system requirements for each platform; for both the editor & running your game.
+
| [[System_Requirements|System Requirements]]: Minimum & recommended system requirements for Visionaire Studio.
 
|}
 
|}
  
{| class="wikitable" style="width:100%;"
+
== A Quick Overview of... ==
 +
{| class="ts" style="width:100%;"
 
|-
 
|-
| '''Quick overview of...''' ||
+
| [[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.
+
| [[System_Menu|the System Menu]]: The system menu of the Visionaire Studio editor.
 
|-
 
|-
| [[System_Menu|the System Menu]] || The system menu of the Visionaire Studio editor.
+
| [[Console_Documentation|the Developer Console]]: The developer/debug console that is available by pressing tab during a game launched via the Visionaire Studio Editor.
 
|-
 
|-
| [[Console_Documentation|the Developer Console]] || The developer/debug console that is available by pressing tab during a game launched via the Visionaire Studio Editor.
+
| [[Game_Tab|the Game tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Game_Tab|the Game tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Loading_Screen_Tab|the Loading Screen tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Loading_Screen_Tab|the Loading Screen tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Scenes_and_Menus_Tab|the Scenes and Menus tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Scenes_and_Menus_Tab|the Scenes and Menus tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Characters_Tab|the Characters tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Characters_Tab|the Characters tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Interfaces_Tab|the Interfaces tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Interfaces_Tab|the Interfaces tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Items_Tab|the Items tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Items_Tab|the Items tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Cursors_Tab|the Cursors tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Cursors_Tab|the Cursors tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Fonts_Tab|the Fonts tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Fonts_Tab|the Fonts tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Texts_Tab|the Texts tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Texts_Tab|the Texts tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Particle_Systems_Tab|the Particle Systems tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Particle_Systems_Tab|the Particle Systems tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Scripts_Tab|the Scripts tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
|-
| [[Scripts_Tab|the Scripts tab]] || See [[#Main Editor Tabs|Main Editor Tabs]].
+
| [[Actionparts|Action Parts]]: A quick explanation of each action part.
|-
 
| [[Actionparts|Action Parts]] || A quick explanation of each action part.
 
 
|}
 
|}
  
{| class="wikitable" style="width:100%;"
+
== All About... ==
 +
{| class="ts" style="width:100%;"
 
|-
 
|-
| '''All About...'''
+
| [[Action_System|Actions]]: A quick explanation of the action system & the various action types that are available.
 
|-
 
|-
| [[Conditions_and_Values|Conditions & Values]] || What are conditions & values? How can we use them?
+
| [[Animation_Tips_and_Tricks|Animations]]: A comprehensive guide on how to get the most out of the animation frame sequencer.
 
|-
 
|-
| [[Displayed_Text|Displayed Text]] || What are the differences between Display text? Display Speaker Text? & Display Object Text?
+
| [[Conditions_and_Values|Conditions & Values]]: What are conditions & values? How can we use them?
 
|-
 
|-
| [[Control_Interfaces|Control Interfaces]] || A quick rundown of control interface types & how to create them.
+
| [[Control_Interfaces|Control Interfaces]]: A quick rundown of control interface types & how to create them.
 
|-
 
|-
| [[Particles|Particles]] || What are particles? & how can we use them to enhance our games?
+
| [[Displayed_Text|Displayed Text]]: What are the differences between Display text? Display Speaker Text? & Display Object Text?
 +
|-
 +
| [[An_Event_in_Time|Events, Loops, & Time]]: A comprehensive summary of various looping & timing methods you can utilize for your in-game events.
 +
|-
 +
| [[Particles|Particles]]: What are particles? & how can we use them to enhance our games?
 
|}
 
|}
  
{| class="wikitable" style="width:100%;"
+
== How to... ==
 +
{| class="ts" style="width:100%;"
 
|-
 
|-
| '''How to...'''
+
| Create a Game Menu:
 
|-
 
|-
| Create a Game Menu ||
+
| Create a Save Menu:
 
|-
 
|-
| Build a Playable Scene ||
+
| Build a Playable Scene:
 
|-
 
|-
| Configure your Characters ||
+
| Configure Your Characters:
 
|-
 
|-
| [[Animation|Create Animations in Visionaire Studio]] ||
+
| [[Animation|Create Animations in Visionaire Studio]]:
 
|-
 
|-
| Build Your Game || How to compile & export your game as an executable (.exe) file, ready for playing.
+
| Build Your Game: How to compile & export your game as an executable (.exe) file, ready for playing.
 
|}
 
|}
  
{| class="wikitable" style="width:100%;"
+
== The Lua Corner ==
 +
{| class="ts" style="width:100%;"
 
|-
 
|-
| '''The Lua Corner'''
+
| [[Scripting|Scripting]]: A quick guide to scripting in Visionaire Studio.
 
|-
 
|-
| [[Scripting|Scripting]] || A quick guide to scripting in Visionaire Studio.
+
| [[Data_Structure|Data Structure]]: A compiled list of scriptable & read only editor actions & options.
 
|-
 
|-
| [[Data_Structure|Data Structure]] || A compiled list of scriptable & read only editor actions & options.
+
| [[Player_Commands|Player Commands]]: A list of Exclusive Lua functions for Visionaire Studio.
 
|-
 
|-
| [[Player_Commands|Player Commands]] || A list of Exclusive Lua functions for Visionaire Studio.
+
| [[Common_Commands|Common Commands]]: A list of Exclusive Lua commands for Visionaire Studio.
 
|-
 
|-
| [[Common_Commands|Common Commands]] || A list of Exclusive Lua commands for Visionaire Studio.
+
| [[Basic_lua:_Index|Basic Lua]]: An introduction to scripting in Lua; for the general layman.
|-
 
| [[Basic_lua|Basic Lua]] || An introduction to scripting in Lua; for the general layman.
 
 
|-  
 
|-  
| [[Compiled_Index_of_Lua_Scripts_for_Visionaire_Studio|Lua Script Index]] || A compiled list of ''shared'' Lua Scripts & examples made by various members of the Visionaire Studio team & community.
+
| [[Compiled_Index_of_Lua_Scripts_for_Visionaire_Studio|Lua Script Index]]: A compiled list of ''shared'' Lua Scripts & examples made by various members of the Visionaire Studio team & community.
 
|}
 
|}
  
{| class="wikitable" style="width:100%;"
+
== A Few Tips... ==
 +
{| class="ts" style="width:100%;"
 
|-
 
|-
| '''A few tips...'''
+
| [[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.
+
| [[Audio_Encoding|on Audio Encoding]]: Recommended audio formats & a few tips on audio encoding/conversion.
 +
|-
 +
| [[Game_Optimization|on Game Optimization]]: Some tips on optimizing your game for mobile devices & mid-low end machines.
 +
|-
 +
| [[Image_Encoding|on Image Encoding]]: Recommended image formats & a few tips on image encoding/conversion.
 +
|-
 +
| [[Motivation,_Inspiration_and_Focus|on Motivation, Inspiration & Focus]]: Some ideas & tips to help boost productivity, as well as advice on what to look out for.
 +
|-
 +
| [[Naming_Conventions_and_Structure|on Name Convention & Structuring]]: tips on name convention & folder structuring.
 +
|-
 +
| [[Video_Encoding|on Video Encoding]]: Recommended video formats & a few tips on video encoding/conversion.
 
|}
 
|}
  
 
== Main Editor Tabs ==
 
== Main Editor Tabs ==
{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+
{| class="ts"
 
|- valign="top"
 
|- valign="top"
 
| <b>Game</b>: This is where you can setup the main game properties: mouse, key input, languages, provide information & version build number etc || width="30px" | [[File:game25.png|right|25px|link=]]
 
| <b>Game</b>: This is where you can setup the main game properties: mouse, key input, languages, provide information & version build number etc || width="30px" | [[File:game25.png|right|25px|link=]]
Line 132: Line 143:
 
| <b>Particle System</b>: This is where you can create particles; like snow, rain, fog, fire etc (advanced users) || [[File:particle25.png|right|25px|link=]]
 
| <b>Particle System</b>: This is where you can create particles; like snow, rain, fog, fire etc (advanced users) || [[File:particle25.png|right|25px|link=]]
 
|- valign="top"
 
|- valign="top"
| <b>Scripts</b>: 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) || [[File:script25.png|right|25px|link=]]
+
| <b>Scripts</b>: 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) || [[File:script25.png|right|25px|link=]]
|}
+
|}{{toc}}

Revision as of 12:25, 2 August 2022

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.
Animations: A comprehensive guide on how to get the most out of the animation frame sequencer.
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?
Events, Loops, & Time: A comprehensive summary of various looping & timing methods you can utilize for your in-game events.
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 Audio Encoding: Recommended audio formats & a few tips on audio encoding/conversion.
on Game Optimization: Some tips on optimizing your game for mobile devices & mid-low end machines.
on Image Encoding: Recommended image formats & a few tips on image encoding/conversion.
on Motivation, Inspiration & Focus: Some ideas & tips to help boost productivity, as well as advice on what to look out for.
on Name Convention & Structuring: tips on name convention & folder structuring.
on Video Encoding: Recommended video formats & a few tips on video encoding/conversion.

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