Difference between revisions of "Installation"
| (2 intermediate revisions by the same user not shown) | |||
| 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 | + | # 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== | ||
| Line 13: | Line 13: | ||
You may also want to modify the key that opens the console, or modify other settings (see [[Settings]]). | You may also want to modify the key that opens the console, or modify other settings (see [[Settings]]). | ||
| + | |||
| + | ==Setup as a Package (v2.0.0+)== | ||
| + | Note: Package setup is entirely optional and is only recommended if you wish to keep your Assets folder cleaner. Unfortunately, the Unity Asset Store does not provide a way for Publishers to upload as Packages, so by default the package will exist in the Assets folder, under Assets/Reflex/ | ||
| + | |||
| + | If you do decide to move reflex to a package, future updates to reflex will download to Assets/Reflex, so you will need to manually move them each time. | ||
| + | |||
| + | As of version 2.0.0, reflex follows the file structure of a [https://docs.unity3d.com/Manual/cus-layout.html Unity Package] and as such can be treated as a Package in your project. If you wish to use reflex as a package then do the following: | ||
| + | * Locate your settings asset by searching <b>ReflexConsoleSettings</b> in your project | ||
| + | ** If you do not have a settings file yet, you can create one by going to Edit -> ProjectSettings... and clicking ReflexCLI (or Project/ReflexCLI) | ||
| + | * Move the Settings asset either outside of the Reflex folder in your Assets, or to Assets/Reflex/Runtime/GameObjects/Resources | ||
| + | ** Settings can live anywhere, but must be in a Resources folder | ||
| + | * Move the Reflex folder to your Packages/Reflex Folder - ReflexCLI will now appear as a package in your project | ||
==Next Steps== | ==Next Steps== | ||
| − | Once you have the Reflex Console in your project, you may wish to look into the [[:Category:Command Library|provided commands]] or create some [[ | + | Once you have the Reflex Console in your project, you may wish to look into the [[:Category:Command Library|provided commands]] or create some [[Creating Commands|custom commands]] of your own. |
Latest revision as of 08:02, 4 February 2021
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
- Download package from the Asset Store into your project.
- Press play in the editor.
- Press Tab to open the console.
- Type "PrintCommands" to display a list of all commands.
- 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).
Setup as a Package (v2.0.0+)
Note: Package setup is entirely optional and is only recommended if you wish to keep your Assets folder cleaner. Unfortunately, the Unity Asset Store does not provide a way for Publishers to upload as Packages, so by default the package will exist in the Assets folder, under Assets/Reflex/
If you do decide to move reflex to a package, future updates to reflex will download to Assets/Reflex, so you will need to manually move them each time.
As of version 2.0.0, reflex follows the file structure of a Unity Package and as such can be treated as a Package in your project. If you wish to use reflex as a package then do the following:
- Locate your settings asset by searching ReflexConsoleSettings in your project
- If you do not have a settings file yet, you can create one by going to Edit -> ProjectSettings... and clicking ReflexCLI (or Project/ReflexCLI)
- Move the Settings asset either outside of the Reflex folder in your Assets, or to Assets/Reflex/Runtime/GameObjects/Resources
- Settings can live anywhere, but must be in a Resources folder
- Move the Reflex folder to your Packages/Reflex Folder - ReflexCLI will now appear as a package in your project
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.
