Difference between revisions of "Installation"

From ReflexCLI
Jump to: navigation, search
Line 3: Line 3:
  
 
==Install and Verify==
 
==Install and Verify==
# Download package from the Asset Store into your project
+
# Download package from the Asset Store into your project.
# Press play in the editor
+
# Press play in the editor.
# Press Tab to open the console
+
# Press Tab to open the console.
# Type HelloWorld to call the HelloWorld command
+
# Type "PrintCommands" to display a list of all commands.
# Hit Escape to close the console
+
# Hit Escape to close the console.
  
 
==Optional Setup==
 
==Optional Setup==

Revision as of 14:39, 24 September 2017

Basic integration of Reflex into your game project is very simple. The system will bootstrap itself into your scene on awake, so there is no need to add prefabs to every scene etc. The following "installation" steps will guide you through basic integration and verification of the console:

Install and Verify

  1. Download package from the Asset Store into your project.
  2. Press play in the editor.
  3. Press Tab to open the console.
  4. Type "PrintCommands" to display a list of all commands.
  5. Hit Escape to close the console.

Optional Setup

If you are using keyboard for in-game input, you will need to do some additional setup to prevent keystrokes from affecting your game while the console is open. See Conflict With Game Inputs for details.

You may also want to modify the key that opens the console, or modify other settings (see Settings).

Next Steps

Once you have the Reflex Console in your project, you may wish to look into the provided commands or create some custom commands of your own.