sumConsole Documentation

25 Jul

This page will contain information from the most current version of the README file included with the sumConsole package on the Unity Asset Store. For more information about this Mobile Debug Console for Unity3d see the project home page. For support comment below, or email me – jerry@cyberlogical.com.

SETUP

  • Create a Canvas if there is not one in your scene already. [Create > UI > Canvas] in Hierarchy
  • Copy the ‘sumConsole’ prefab onto the canvas.
  • Set ‘Scripts/sumConsole/sumConsole.cs’ to execute FIRST.
    • NOTE: The console will work without this, but some messages could be missed
    • In Unity 5.x: Edit | Project Settings | Script Execution Order
    • Click the ‘+’ and select the script ‘sumConsole’, drag the sumConsole bar to the top, and click ‘Apply’
    • More info: http://docs.unity3d.com/Manual/class-ScriptExecution.html
  • Set ‘Write Access’ for project to “External” for Android
    • NOTE: The console will work without this, but logs may not save to the device properly
    • Make sure you have the Android Platform selected for your build
    • In Unity 5.x: File | Build Settings | Player Settings | Other Settings | Write Access
  • Ensure ‘Api Compatibility Level’ is on the “.NET 2.0 Subset”
    • In Unity 5.x: File | Build Settings | Player Settings | Optimization
    • Not available for Web Player.

USAGE

  • Run your scene containing the prefab. Press the ‘Console’ button to open and view your log.
  • Logging is done as usual. Simply use Debug.Log("message"); like you would normally.
  • System messages will be captured. Warnings will show in magenta (purple) text and errors will show in red.
  • You can turn sumConsole off for production builds by disabling/deleting the game object in your scene before building, or create a menu option to turn it on/off (not included).

Check the sumConsoleSample scene in the ‘Example’ folder for working example

OPTIONS

Settings can be adjusted on the ‘SumConsole’ component via the inspector

Console Settings

Basic Settings

  • Start Opened : If checked the console will be completely open when the scene starts. [def: off]
  • Always Show FPS : If checked the FPS (Frames Per Second) counter will always be visible. [def: on]

Performance Settings

  • Performance : Use the slider to select your preferred settings. Far right settings allows you to enter custom values. [def: 2]

Custom Performance Settings

Log Sizes

  • Max Console Entries : Maximum length of console log (in number of entries) [def: varies]
  • Max Log Entries : Maximum length of saved log (in number of entries) [def: varies]

FPS Settings

  • Min High FPS : Anything above this will show as green. [def: varies]
  • Max Low FPS : Anything below this will show as red. [def: varies]
    • (Anything in between these 2 values will be yellow)
  • FPS Updates/Second : Number of updates per second [def: varies]
    • WARNING: High Update Rate can effect performance negatively.

Prefabs and Links

Links to the UI prefab and game objects the script needs to access. You should not need to edit these.

EXAMPLE

‘sumConsoleSample’ scene contains an example in action.

PROJECT LICENSE

CREATED BY

CHANGE NOTES


  • v 1.2
  • Now requires Unity 5.3.5
  • Removed ‘Keep Alive’ option
  • Replaced multiple prefabs with one
  • Created custom editor to simplify settings
  • Console entries now displayed via preloaded UI objects
  • Length of console based on entries instead of characters
  • Changed log storage method for improved performance

  • v 1.1
  • Now requires Unity 5.3.2 for ‘Raycast Target’ option and Scroll Bar
  • Added prefab with scrolling ability (more detailed, but lower performance)
  • Performance improvements
  • Changed output to newest on bottom
  • Added character limit for console length
  • Changed log length variable
  • Added looping test statement to sample script (uncomment in Start() to run)

  • v 1.0
  • Initial version

Leave a Reply

Your email address will not be published. Required fields are marked *