Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
konraddysput committed Apr 6, 2020
1 parent f94f495 commit 58b15a4
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ catch(Exception exception){
- Light-weight Unity client that quickly submits crashed generated in Unity environment to your Backtrace dashboard
- Can include callstack, system metadata, custom metadata, custom attributes and file attachments if needed
- Supports a wide range of unity version and environments
- Supports .NET 4.5 Backend, IL2CPP and Mono environments
- Supports .NET 2.0/3.5/4.5/Standard 2.0 Backend, IL2CPP and Mono environments
- Supports offline database for error report storage and re-submission in case of network outage
- Fully customizable and extendable event handlers
- Custom IDE integrations

# Prerequisites

- Unity environment 2017.4.x
- .NET 4.5 scripting runtime version
- .NET 2.0/3.5/4.5/Standard 2.0 scripting runtime version
- Mono or IL2CPP scripting backend

# Setup <a name="installation"></a>
Expand All @@ -42,7 +42,7 @@ List of steps necessary to setup full Backtrace Unity integration.
## Installation guide

- Download the backtrace-unity zip file. Unzip it and keep the folder in a known location. It can be downloaded from https://github.com/backtrace-labs/backtrace-unity/releases
- Open your Unity project and ensure it is configured to build with .NET 4.5+ runtime and a mono or il2cpp backend.
- Open your Unity project
- Copy the unzipped folder to your project's asset folder in the Windows File Explorer. The Unity editor will refresh and the Backtrace Plugin should become available in the editor.

## Integrating into your project
Expand All @@ -57,6 +57,10 @@ List of steps necessary to setup full Backtrace Unity integration.

Watch this 1 minute silent video to see the Integration and Configuration in action. The first 20 seconds of the video shows the above Integrating steps, and the second part shows details of the below Client and Database Settings - https://player.vimeo.com/video/300051476

## Plugin best practices

Plugin allows you to define maximum depth of game objects. By default its disabled (Game object depth is equal to -1). If you would like to include all game objects, please select 0. If you would like to specify game object depth size to n, please insert n in Backtrace configuration text box.

## Backtrace Client and Offline Database Settings

The following is a reference guide to the Backtrace Client fields:
Expand Down

0 comments on commit 58b15a4

Please sign in to comment.