Skip to content

Commit 5a03c80

Browse files
authored
Update README.md
1 parent ca60fe4 commit 5a03c80

File tree

1 file changed

+61
-2
lines changed

1 file changed

+61
-2
lines changed

README.md

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,61 @@
1-
# unity
2-
Receive comprehensive bug reports for your Unity games that will help you debug, fix, and build better games, faster!
1+
# **Instabug for Mobile Games**
2+
Detailed bug reporting and in-app chat for mobile games made on Android, iOS, and Unity!
3+
4+
5+
<img src="https://user-images.githubusercontent.com/9888943/41102891-337c4170-6a68-11e8-8b89-73f60ab6ad81.png" width="35%"/><img src="https://user-images.githubusercontent.com/9888943/41102892-339dab08-6a68-11e8-895c-89c5c92dc4ed.png" width="63%"/>
6+
7+
8+
Collect in-game bug reports and feedback and speed up your game development cycle with Instabug. Forward your bugs automatically to Trello, Jira, Slack, Github, Gitlab & more.
9+
10+
For more info, visit Instabug for Unity on [instabug.com](https://www.instabug.com/platforms/unity).
11+
12+
## Installation (iOS)
13+
14+
1. Add Instabug for iOS on the [Asset Unity Store here](https://assetstore.unity.com/packages/tools/integration/instabug-for-ios-116191).
15+
16+
2. Add an empty GameObject to your project, and add the InstabugiOS script component to it.
17+
18+
3. Click on Add Component, search for InstabugiOS, and add it to the game object.
19+
20+
4. Add your app token, and change the invocation event from Unity’s Inspector directly.
21+
22+
## Installation (Android)
23+
24+
1. Add Instabug for Android on the [Asset Unity Store here](https://assetstore.unity.com/packages/tools/integration/instabug-for-android-116200).
25+
26+
2. Export your Unity project by opening Build Settings from “File —> Build Settings”, and checking the Export button. Choose your desired path to save the project.
27+
28+
3. Open the exported project from Android Studio, and add the following changes to the build.gradle file.
29+
```
30+
... allprojects { repositories { jcenter() google() maven { // TODO add this only if interested in getting SNAPSHOT releases url ‘https://oss.sonatype.org/content/repositories/snapshots’ } ... } } ... dependencies { ... compile ‘com.instabug.library:instabug:5.0.0.3.19-SNAPSHOT’ } ...
31+
```
32+
4. Create a new Application.java class that should look like this. Add your app token, and change the invocation event from this class.
33+
```
34+
... import android.app.Application; import com.instabug.library.Instabug; import com.instabug.library.invocation.InstabugInvocationEvent; ... public class MyApp extends Application { @Override public void onCreate() { super.onCreate(); // You can change the invocation event to NONE, FLOATING_BUTTON, // SCREENSHOT_GESTURE, or TWO_FINGER_SWIPE_LEFT. new Instabug.Builder(this, “YOUR_APP_TOKEN”) .setInvocationEvent(InstabugInvocationEvent.SHAKE) .build(); Instabug.setUnityEnabled(true); } }
35+
```
36+
5. Add the Application class name to the AndroidManifest.xml file.
37+
```
38+
<manifest xmlns:android=“http://schemas.android.com/apk/res/android” ...> ... <application android:name=“.MyApp” ...> ... </application> ... </manifest>
39+
```
40+
41+
42+
43+
## Steps
44+
45+
**1. Add Instabug to Your Game**
46+
See Installation steps above.
47+
48+
**2. Shake The Phone**
49+
Your users can shake their devices to report bugs or submit their feedback from within your app with zero interruption to their experience.
50+
51+
**3. View Detailed Bug Reports**
52+
With each bug report your users submit, we automatically capture comprehensive metadata to help you identify the cause of errors and fix issues faster.
53+
54+
55+
## Documentation
56+
57+
For more details about the supported APIs and how to use them, you can check our [**Documentation**](https://docs.instabug.com/docs/unity).
58+
59+
## Contact Us
60+
61+
If you have any questions or feedback don’t hesitate to get in touch. You can reach us at any time through **[[email protected]](mailto:[email protected])**.

0 commit comments

Comments
 (0)