You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation.html
+26-2Lines changed: 26 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,18 @@
58
58
<body>
59
59
<h1>BetaHub Unity Plugin Documentation</h1>
60
60
61
+
<divclass="note">
62
+
<h3>API Usage and Terms</h3>
63
+
<p>This plugin connects to the BetaHub API at <ahref="https://betahub.io">betahub.io</a>. Key points:</p>
64
+
<ul>
65
+
<li><strong>Free Access:</strong> All users get full access to every feature without volume limits</li>
66
+
<li><strong>Video Storage:</strong> Free users can upload up to 60 seconds of video per submission, with no additional fees</li>
67
+
<li><strong>No Subscription Required:</strong> The free account allows unlimited feedback reporting</li>
68
+
<li><strong>Demo Project Included:</strong> The plugin includes a demo project for immediate testing without configuration</li>
69
+
</ul>
70
+
<p>For complete API terms and conditions, visit <ahref="https://betahub.io/api-terms">betahub.io/api-terms</a></p>
71
+
</div>
72
+
61
73
<p>Welcome to the BetaHub Unity Plugin! This guide will help you integrate our bug reporting tool into your Unity project, streamlining the process of collecting and managing bug reports from your game testers and players.</p>
62
74
63
75
<h2>Prerequisites</h2>
@@ -104,11 +116,21 @@ <h2>IL2CPP Support and FFmpeg Video Recording</h2>
104
116
105
117
<h3>Quick Start</h3>
106
118
119
+
<divclass="note">
120
+
<strong>Demo Project:</strong> The plugin comes pre-configured with a demo project, so you can test bug submissions immediately without any setup. Demo submissions are unlisted, and you'll find a link to view them in the Unity console log after submission.
121
+
</div>
122
+
107
123
<ol>
108
124
<li>Locate the BugReportingFormCanvas prefab in Packages/BetaHub Bug Reporter/Runtime/Prefabs.</li>
109
125
<li>Drag it into your scene.</li>
110
-
<li>Select the newly created BugReportingFormCanvas object in the hierarchy.</li>
111
-
<li>In the inspector, find the <code>Project ID</code> field and enter your BetaHub project ID.</li>
126
+
<li>Run your game and press <code>F12</code> to test the bug report form with the demo project.</li>
127
+
<li>To use your own project:
128
+
<ul>
129
+
<li>Select the BugReportingFormCanvas object in the hierarchy</li>
130
+
<li>In the inspector, find the <code>Project ID</code> field and enter your BetaHub project ID</li>
131
+
<li>Enter your <code>Auth Token</code> (found in Project Settings > Integrations > Tokens)</li>
132
+
</ul>
133
+
</li>
112
134
</ol>
113
135
114
136
<p>You're all set! Run your game and press <code>F12</code> to open the bug report form.</p>
@@ -118,6 +140,8 @@ <h3>Configuration</h3>
118
140
<p>Adjust these settings in the BugReportingFormCanvas inspector:</p>
119
141
120
142
<ul>
143
+
<li><strong>Project ID</strong>: Your BetaHub project identifier (found in Project Settings > General > Project Information).</li>
144
+
<li><strong>Auth Token</strong>: Your application token for API authentication (found in Project Settings > Integrations > Tokens). This is <strong>not an API key</strong> and does not need to be kept secret - it's a project identifier that helps prevent API abuse and spam while identifying your application.</li>
121
145
<li><strong>Shortcut Key</strong>: Default is F12. Set to None to disable and open the form programmatically.</li>
0 commit comments