Difference between revisions of "Manual"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(redirect to home)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
This is the official documentation for Visionaire Studio: Adventure Game Engine. <br/>
+
#REDIRECT [[Main_Page]]
Please use the links below to navigate.
 
 
 
== Introducing... ==
 
{| class="ts" style="width:100%;"
 
|-
 
| [[An_Introduction_to_Visionaire_Studio:_Adventure_Game_Engine|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.
 
|}
 
 
 
== General Information... ==
 
{| class="ts" style="width:100%;"
 
|-
 
| [[Visionaire_Studio_Licenses|License Options]]: Here are the available license plans for Visionaire Studio.
 
|-
 
| [[System_Requirements|System Requirements]]: Minimum & recommended system requirements for Visionaire Studio.
 
|}
 
 
 
== A Quick Overview of... ==
 
{| 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.
 
|-
 
| [[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.
 
|-
 
| [[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]].
 
|-
 
| [[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]].
 
|-
 
| [[Interfaces_Tab|the Interfaces 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]].
 
|-
 
| [[Fonts_Tab|the Fonts 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]].
 
|-
 
| [[Scripts_Tab|the Scripts tab]]: See [[#Main Editor Tabs|Main Editor Tabs]].
 
|-
 
| [[Actionparts|Action Parts]]: A quick explanation of each action part.
 
|}
 
 
 
== All About... ==
 
{| class="ts" style="width:100%;"
 
|-
 
| [[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?
 
|-
 
| [[Control_Interfaces|Control Interfaces]]: A quick rundown of control interface types & how to create them.
 
|-
 
| [[Displayed_Text|Displayed Text]]: What are the differences between Display text? Display Speaker Text? & Display Object Text?
 
|-
 
| [[Particles|Particles]]: What are particles? & how can we use them to enhance our games?
 
|}
 
 
 
== How to... ==
 
{| class="ts" style="width:100%;"
 
|-
 
| Create a Game Menu:
 
|-
 
| Create a Save Menu:
 
|-
 
| Build a Playable Scene:
 
|-
 
| Configure Your Characters:
 
|-
 
| [[Animation|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 ==
 
{| class="ts" style="width:100%;"
 
|-
 
| [[Scripting|Scripting]]: A quick guide to scripting in Visionaire Studio.
 
|-
 
| [[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.
 
|-
 
| [[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.
 
|-
 
| [[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.
 
|}
 
 
 
== A Few Tips... ==
 
{| 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.
 
|-
 
| [[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.
 
|-
 
| [[Animation_Tips_and_Tricks|on Animations]]: Tips & tricks on how to get the most out of the animation frame sequencer.
 
|}
 
 
 
== Main Editor Tabs ==
 
{| class="ts"
 
|- 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=]]
 
|- valign="top"
 
| <b>Loading Screen</b>: You can create an incrementally loading splash screen here; to display on game start || [[File:loading25.png|right|25px|link=]]
 
|- valign="top"
 
| <b>Scenes & Menus</b>: This is where you can create, build & design your scenes, menus, objects & actions to be performed etc || [[File:scene25.png|right|25px|link=]]
 
|- valign="top"
 
| <b>Characters</b>: This is where you can create your characters, outfits & animations etc || [[File:character25.png|right|25px|link=]]
 
|- valign="top"
 
| <b>Interfaces</b>: This is where you can create your main game control interface & on screen interfaces; such as inventory etc || [[File:interface25.png|right|25px|link=]]
 
|- valign="top"
 
| <b>Items</b>: This is where you create items that can be picked up, stored in your inventory, given to other characters or combined with other objects || [[File:item25.png|right|25px|link=]]
 
|- valign="top"
 
| <b>Cursors</b>: This is where you create & animate mouse cursors you will be using throughout your game || [[File:cursor25.png|right|25px|link=]]
 
|- valign="top"
 
| <b>Fonts</b>: 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 || [[File:font25.png|right|25px|link=]]
 
|- valign="top"
 
| <b>Texts</b>: 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 || [[File:text25.png|right|25px|link=]]
 
|- valign="top"
 
| <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"
 
| <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}}
 

Latest revision as of 10:44, 29 April 2023

Redirect to: