Skip to content

Commit 5ec0183

Browse files
nickdowellnickdowell
authored
Prepare repo for public (#121)
1 parent f36560e commit 5ec0183

File tree

7 files changed

+172
-2
lines changed

7 files changed

+172
-2
lines changed

‎.cspell.json

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"words": [
55
"Appium",
66
"BSGJSON",
7+
"Bugsnag",
78
"Expojs",
89
"GRHI",
910
"JNICALL",
@@ -28,6 +29,7 @@
2829
"jobject",
2930
"jsize",
3031
"ooms",
32+
"uproject",
3133
],
3234
"ignorePaths": [
3335
"**/Intermediate/**",

‎.github/ISSUE_TEMPLATE/A.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Having trouble getting started?
3+
about: Please contact us at [email protected] for assistance with integrating Bugsnag
4+
into your application.
5+
title: ''
6+
labels: ''
7+
assignees: ''
8+
9+
---
10+
Please check out our [documentation](https://docs.bugsnag.com/platforms/unreal-engine/) for guides, references and tutorials.
11+
12+
If you have questions about your integration please contact us at [[email protected]](mailto:[email protected]).
13+
14+
Alternatively, view additional options at [SUPPORT.md](../SUPPORT.md).

‎.github/ISSUE_TEMPLATE/Bug_report.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve the library
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Before raising, please check if somebody else has already reported your issue. -->
11+
12+
### Describe the bug
13+
A clear and concise description of what the bug is.
14+
15+
### Steps to reproduce
16+
1. Go to '...'
17+
2. Click on '....'
18+
3. Scroll down to '....'
19+
4. See error
20+
21+
### Environment
22+
* Bugsnag version:
23+
* Unreal Engine version:
24+
* Target platform & version:
25+
26+
<!--
27+
Below are a few approaches you might take to communicate the issue, in
28+
descending order of awesomeness. Please choose one and feel free to delete
29+
the others from this template.
30+
-->
31+
32+
### Example Repo <!-- Option 1 -->
33+
34+
- [ ] Create a minimal repository that can reproduce the issue
35+
- [ ] Link to it here:
36+
37+
### Example code snippet <!-- Option 2 -->
38+
39+
```
40+
# (Insert code sample to reproduce the problem)
41+
```
42+
43+
<!-- Error messages, if any -->
44+
<details><summary>Error messages:</summary>
45+
46+
```
47+
48+
```
49+
</details>

‎.github/ISSUE_TEMPLATE/Feature_request.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Before creating, please check if somebody else has already reported your feature request. -->
11+
12+
### Description
13+
<!-- Is your feature request related to a problem? Please describe.
14+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
-->
16+
17+
**Describe the solution you'd like**
18+
<!-- A clear and concise description of what you want to happen. -->
19+
20+
**Describe alternatives you've considered**
21+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
22+
23+
**Additional context**
24+
<!--Add any other context about the feature request here.-->

‎.github/SUPPORT.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Are you having trouble getting started?
2+
If you haven't already, please check out our [documentation](https://docs.bugsnag.com/platforms/unreal-engine/) for guides, references and tutorials.
3+
4+
Or, if you wish you can [contact us directly](mailto:[email protected]) for assistance on integrating Bugsnag into your application, troubleshooting an issue or a question about our supported features.
5+
6+
When contacting support, please include as much information as necessary, including:
7+
8+
- example code snippet
9+
- steps to reproduce
10+
- expected/actual behaviour
11+
12+
* Bugsnag version:
13+
* Unreal Engine version:
14+
* Target platform & version:
15+
* Developer tools (Android Studio, Xcode, etc.) version(s):
16+
17+
## Bug or Feature Requests
18+
If you would like to raise a bug or feature request please do so by creating a [New Issue](https://github.com/bugsnag/bugsnag-unreal/issues/new/choose) and selecting bug or feature.
19+
Please note: we cannot promise that we will fulfil all requests

‎LICENSE

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Copyright (c) 2021 Bugsnag
2+
3+
Permission is hereby granted, free of charge, to any person obtaining
4+
a copy of this software and associated documentation files (the
5+
"Software"), to deal in the Software without restriction, including
6+
without limitation the rights to use, copy, modify, merge, publish,
7+
distribute, sublicense, and/or sell copies of the Software, and to
8+
permit persons to whom the Software is furnished to do so, subject to
9+
the following conditions:
10+
11+
The above copyright notice and this permission notice shall be
12+
included in all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+44-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
1-
# bugsnag-unreal
1+
# Bugsnag crash monitoring and reporting plugin for Unreal Engine
2+
[![Documentation](https://img.shields.io/badge/documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/unreal-engine/)
23

3-
Bugsnag crash monitoring and reporting tool for Unreal Engine apps
4+
Automatically detect crashes and fatal errors in your Unreal Engine games on Android and iOS, collecting diagnostic information and immediately notifying your development team to help you to understand and resolve issues as fast as possible.
5+
6+
Supports Unreal Engine 4.24 and later.
7+
8+
9+
## Features
10+
11+
* Automatically report crashes and fatal errors
12+
* Report [handled exceptions](https://docs.bugsnag.com/platforms/unreal-engine/#reporting-handled-errors)
13+
* [Log breadcrumbs](https://docs.bugsnag.com/platforms/unreal-engine/#logging-breadcrumbs) which are attached to crash reports and add insight to users' actions
14+
* [Attach user information](https://docs.bugsnag.com/platforms/unreal-engine/#identifying-users) to determine how many people are affected by a crash
15+
16+
17+
## Getting started
18+
19+
1. [Create a Bugsnag account](https://bugsnag.com)
20+
1. Complete the instructions in the [integration guide](https://docs.bugsnag.com/platforms/unreal-engine/) to report crashes from your game
21+
1. Report handled exceptions using [`UBugsnagFunctionLibrary::Notify()`](https://docs.bugsnag.com/platforms/unreal-engine/#reporting-handled-errors)
22+
1. Customize your integration using the [configuration options](https://docs.bugsnag.com/platforms/unreal-engine/configuration-options/)
23+
24+
25+
## Support
26+
27+
* [Read the integration guide](https://docs.bugsnag.com/platforms/unreal-engine/) or [configuration options documentation](https://docs.bugsnag.com/platforms/unreal-engine/configuration-options/)
28+
* [Search open and closed issues](https://github.com/bugsnag/bugsnag-unreal/issues?utf8=✓&q=is%3Aissue) for similar problems
29+
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-unreal/issues/new)
30+
31+
32+
## Repository organization
33+
34+
The Bugsnag plugin is located in [`Plugins/Bugsnag`](Plugins/Bugsnag).
35+
36+
The top level of this repository contains an example project which uses the Bugsnag plugin - [`BugsnagExample.uproject`](BugsnagExample.uproject).
37+
38+
To build the example project for Android or iOS, you must first run `make` in the top level directory to prepare the dependencies.
39+
This step requires macOS with the Android NDK & SDK and Xcode.
40+
41+
42+
## License
43+
44+
The Bugsnag Unreal Engine notifier is free software released under the MIT License.
45+
See the [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)