Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spacemadness/lunar-unity-console

High-performance Unity iOS/Android logger built with native platform UI
https://github.com/spacemadness/lunar-unity-console

android developer-tools development gesture ios mobile multi-touch-gestures stack-trace-frames unity unity-android unity-asset unity-ios unity3d unity3d-plugin

Last synced: about 1 month ago
JSON representation

High-performance Unity iOS/Android logger built with native platform UI

Awesome Lists containing this project

README 

        
# Lunar Unity Mobile Console



[![Build Status](https://travis-ci.com/SpaceMadness/lunar-unity-console.svg?branch=master)](https://travis-ci.com/SpaceMadness/lunar-unity-console)

[![saythanks](https://img.shields.io/badge/say-thanks-ff69b4.svg)](https://saythanks.io/to/weeeBox)



Asset store links:  

- PRO: [https://assetstore.unity.com/packages/tools/gui/lunar-mobile-console-pro-43800](https://assetstore.unity.com/packages/tools/gui/lunar-mobile-console-pro-43800)  

- FREE: [https://assetstore.unity.com/packages/tools/gui/lunar-mobile-console-free-82881](https://assetstore.unity.com/packages/tools/gui/lunar-mobile-console-free-82881)  

  

Requires Unity 5.2 or later.



**iOS demo app:** ~~coming soon~~ Apple forbids any kind of demos on the AppStore. Investigating...  

**Android demo app:** https://play.google.com/store/apps/details?id=com.spacemadness.LunarConsole

  

[discord](https://discord.gg/qhNPuEN)  



**If you enjoy using the plugin - please, [rate and review](https://www.assetstore.unity3d.com/en/#!/account/downloads/search=Lunar%20Mobile%20Console) on the Asset Store!**






## Table of Contents

- [About](#about)

  - [Platform Support](#platform-support)

  - [Key Benefits](#key-benefits)

  - [Features](#features)

- [Installation](#installation)

- [Usage](#usage)

  - [Configuration](#configuration)

  - [User-Defined Actions & Variables](#user-defined-actions-and-variables-only-available-in-pro-version)

  - [Stack Trace Frames](#stack-trace-frames)

  - [Enabling/Disabling Plugin](#enablingdisabling-plugin)

  - [Unity Cloud Build Support](#unity-cloud-build-support)

  - [Build System Support](#build-system-support)

- [Troubleshooting](#troubleshooting)

- [Miscellaneous](#miscellaneous)

  - [Check for Updates](#check-for-updates)

  - [Bug Reports](#bug-reports)

  - [Contacts](#contacts)

  - [Social Media](#social-media)



## About

The project goal is to build a high-performance and lightweight Unity native iOS/Android console for ease of testing and debugging.  



- Check [Official Wiki](https://github.com/SpaceMadness/lunar-unity-console/wiki) for additional information, troubleshooting and guides.

- Visit [Unity Forums Thread](http://forum.unity3d.com/threads/lunar-mobile-console-high-performance-unity-ios-android-logger-built-with-native-platform-ui.347650/) for discussions and general questions.



### Platform Support

- **iOS**: requires iOS 8 or later

- **Android**: requires API Level 14 or later

  

### Key Benefits

- Native C/Objective-C/Java code with a low memory footprint.

- Works well with huge logs amount (up to 65536 entries).

- Completely built with native iOS/Android UI (does NOT rely on Unity GUI).

- Resolution independent (looks great on highres/retina displays).

- Does NOT modify scenes and does NOT add new assets.

- Removes completely from the release build with a single mouse click or from command line (absolutely NO traces left).



### Features

- Instant error notification (never miss an unhandled exception again):  



- Quick logger output access with a multi touch gesture:  



- Crystal clear font and a nice mobile-friendly interface:  



- User-Defined Actions & Variables (currently in preview):  



- Transparent log overlay view:  



- Filter by text and log type:  





- Collapse similar elements:  



- Tap log entry to view the stack trace:  



- Copy-to-clipboard and e-mail options.

- Automatic updates!

 

## Installation

- **Automatic**:  

  Unity Editor Menu:  Window ▶ Lunar Mobile Console ▶ Install...

  

- **Manual**:  

  Drag'n'Drop `LunarConsol.prefab` (Assets/LunarConsole/Scripts/LunarConsole.prefab) into your current scene hierarchy and save your changes. You only need to do it once for your startup scene.



## Usage

You can open the console with a multi touch gesture or using the API call from a script (see [API Guide](https://github.com/SpaceMadness/lunar-unity-console/wiki/API-Guide) for details).



### Configuration

- Select `LunarConsole` game object in the `Hierarchy` window.  

  

- Find `Lunar Console` script settings in the `Inspector` window.  

    

  - Set the capacity (the maximum number of lines the console can hold). It's advised to keep this amount low (the more you have - the more memory it will take).

  - Set the trim amount (how many lines will be removed from the beginning of the log when console overflows).

  - Choose a gesture from the drop down list or select `None` to completely disable multi touch gestures (you would still be able to open the console from your scripts).

  - Check "Remove Rich Text Tags" to remove rich text tags from the output (may cause performance overhead).



### User-Defined Actions and Variables (only available in PRO version)

For more information on Actions and Variables check the user [guide](https://github.com/SpaceMadness/lunar-unity-console/wiki/Actions-and-Variables).



### Stack Trace Frames

Touch the log entry to view its stack trace.



*Important*: make sure to properly configure your build settings (File ▶ Build Settings...) otherwise you will only be able to see exceptions traces.



- iOS: check the "Development Build" checkbox  

  



- Android: check the "Development Build" checkbox  

  



For more info see:

http://docs.unity3d.com/Manual/PublishingBuilds.html



### Enabling/Disabling Plugin



If Lunar Mobile Console is

- _enabled_ - the plugin files would appear in your iOS/Android build: you can access the console with a multi touch gesture or from a script.

- _disabled_ - the plugin files would **NOT** appear in your iOS/Android build: you can't access the console (multi touch gestures or API calls would be ignored).



To

- disable:  

  Window ▶ Lunar Mobile Console ▶ Disable

- enable:  

  Window ▶ Lunar Mobile Console ▶ Enable



**Important:** make sure to "replace" your generated Xcode project whenever you switch the plugin from enabled to disabled (or back). Failing to do so may lead to an unexpected result!  






For more detailed information check Wiki page: [Enabling and Disabling Lunar Mobile Console](https://github.com/SpaceMadness/lunar-unity-console/wiki/Enabling-and-Disabling-Lunar-Mobile-Console).



### Unity Cloud Build Support

Lunar Mobile Console is fully compatible with Unity Cloud Build.  

- For more information check the user [guide](https://github.com/SpaceMadness/lunar-unity-console/wiki/Unity-Cloud-Build-Support)

- For Cloud Build related issues check the troubleshooting [guide](https://github.com/SpaceMadness/lunar-unity-console/wiki/Troubleshooting#unity-cloud-build)



### Build System Support

You can enable/disable the plugin from the command line (and make it a part of your build process)



- To disable:  

  ```  -quit -batchmode  -executeMethod LunarConsoleEditorInternal.Installer.DisablePlugin```

- To enable:  

  ```  -quit -batchmode  -executeMethod LunarConsoleEditorInternal.Installer.EnablePlugin```



`````` locations:

- Mac OS X: ```/Applications/Unity/Unity.app/Contents/MacOS/Unity```

- Windows: ```c:\Program Files\Unity\Editor\Unity.exe```

- Linux: _TBD_  

**Note:** if you're using Lunar Mobile Console older than v0.8.0 (v0.0.1b-v0.7.1) you would need to use ```LunarConsolePluginInternal.Installer.DisablePlugin``` and ```LunarConsolePluginInternal.Installer.EnablePlugin``` instead.

 

## Troubleshooting

Please, visit the [Troubleshooting](https://github.com/SpaceMadness/lunar-unity-console/wiki/Troubleshooting) Wiki page or post your question on the official forum [thread](http://forum.unity3d.com/threads/lunar-mobile-console-high-performance-unity-ios-android-logger-built-with-native-platform-ui.347650/).



## Miscellaneous

### Check for Updates

Window ▶ Lunar Mobile Console ▶ Check for updates...



### Bug Reports

Window ▶ Lunar Mobile Console ▶ Report bug...

 

### Contacts

For anything else: [email protected]



### Social Media

- Twitter: [@LunarPlugin](https://twitter.com/LunarPlugin)

- Facebook: [www.facebook.com/LunarPlugin](https://www.facebook.com/LunarPlugin)

- Unity Forums Thread: [[Lunar Mobile Console] High-performance Unity iOS/Android logger built with native platform UI](http://forum.unity3d.com/threads/lunar-mobile-console-high-performance-unity-ios-android-logger-built-with-native-platform-ui.347650/)



# Thanks for using Lunar Mobile Console!