Skip to content

Commit e7b8cb9

Browse files
Initial commit
0 parents  commit e7b8cb9

27 files changed

Lines changed: 450 additions & 0 deletions

.gitattributes

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Set the default behavior, in case users don't have core.autocrlf set.
2+
* text=auto
3+
4+
# Unity-specific files
5+
*.unity binary
6+
*.prefab binary
7+
*.fbx binary
8+
*.png binary
9+
*.jpg binary
10+
*.gif binary
11+
*.psd binary
12+
*.tga binary
13+
*.dds binary
14+
*.ai binary
15+
*.mp3 binary
16+
*.ogg binary
17+
*.wav binary
18+
*.mp4 binary
19+
*.mov binary
20+
*.anim binary
21+
*.asset binary
22+
*.meta text
23+
*.controller binary
24+
*.physicMaterial binary
25+
*.physicsMaterial2D binary
26+
*.mask binary
27+
*.spriteatlas binary
28+
*.shader text
29+
*.compute text
30+
*.cginc text
31+
*.glslinc text
32+
*.hlsl text
33+
*.shadergraph binary
34+
*.shadervariants binary
35+
*.mat binary
36+
*.flare binary
37+
*.guiskin binary
38+
*.fontsettings binary
39+
*.rendertexture binary
40+
*.lighting binary
41+
*.mesh binary
42+
*.exr binary
43+
*.prefab binary
44+
45+
# Force text for specific file types
46+
*.cs text
47+
*.json text
48+
*.md text
49+
*.xml text
50+
*.yaml text
51+
*.yml text
52+
*.asmdef text
53+
*.jslib text
54+
*.txt text
55+
*.html text
56+
*.htm text
57+
*.css text
58+
*.scss text
59+
*.less text
60+
*.csv text
61+
*.svg text
62+
*.cg text
63+
*.cgh text
64+
65+
# Force binary for specific file types
66+
*.a binary
67+
*.so binary
68+
*.dll binary
69+
*.lib binary
70+
*.exe binary
71+
*.apk binary
72+
*.ipa binary
73+
*.7z binary
74+
*.zip binary
75+
*.rar binary
76+
*.tar binary
77+
*.gz binary
78+
*.bz2 binary
79+
*.unitypackage binary
80+
81+
# Git LFS (Large File Storage) for large binary files
82+
*.psd filter=lfs diff=lfs merge=lfs -text
83+
*.fbx filter=lfs diff=lfs merge=lfs -text

.gitignore

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# This .gitignore file should be placed at the root of your Unity project directory
2+
#
3+
# Get latest from https://github.com/github/gitignore/blob/main/Unity.gitignore
4+
#
5+
/[Ll]ibrary/
6+
/[Tt]emp/
7+
/[Oo]bj/
8+
/[Bb]uild/
9+
/[Bb]uilds/
10+
/[Ll]ogs/
11+
/[Uu]ser[Ss]ettings/
12+
13+
Samples.meta
14+
15+
# MemoryCaptures can get excessive in size.
16+
# They also could contain extremely sensitive data
17+
/[Mm]emoryCaptures/
18+
19+
# Recordings can get excessive in size
20+
/[Rr]ecordings/
21+
22+
# Uncomment this line if you wish to ignore the asset store tools plugin
23+
# /[Aa]ssets/AssetStoreTools*
24+
25+
# Autogenerated Jetbrains Rider plugin
26+
/[Aa]ssets/Plugins/Editor/JetBrains*
27+
28+
# Visual Studio cache directory
29+
.vs/
30+
31+
# Gradle cache directory
32+
.gradle/
33+
34+
# Autogenerated VS/MD/Consulo solution and project files
35+
ExportedObj/
36+
.consulo/
37+
*.csproj
38+
*.unityproj
39+
*.sln
40+
*.suo
41+
*.tmp
42+
*.user
43+
*.userprefs
44+
*.pidb
45+
*.booproj
46+
*.svd
47+
*.pdb
48+
*.mdb
49+
*.opendb
50+
*.VC.db
51+
52+
# Unity3D generated meta files
53+
*.pidb.meta
54+
*.pdb.meta
55+
*.mdb.meta
56+
57+
# Unity3D generated file on crash reports
58+
sysinfo.txt
59+
60+
# Builds
61+
*.apk
62+
*.aab
63+
*.unitypackage
64+
*.app
65+
66+
# Crashlytics generated file
67+
crashlytics-build.properties
68+
69+
# Packed Addressables
70+
/[Aa]ssets/[Aa]ddressable[Aa]ssets[Dd]ata/*/*.bin*
71+
72+
# Temporary auto-generated Android Assets
73+
/[Aa]ssets/[Ss]treamingAssets/aa.meta
74+
/[Aa]ssets/[Ss]treamingAssets/aa/*

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Change Log
2+
3+
## [0.0.0-beta] - MM DD, YYYY
4+
- First commit

CHANGELOG.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing to MyPackage
2+
3+
First off, thank you for considering contributing to MyPackage. Any contributions you make are **greatly appreciated**.
4+
5+
## How to Contribute
6+
7+
There are many ways you can contribute to our project:
8+
9+
- Submitting bug reports and feature requests
10+
- Writing tutorials or blog posts
11+
- Improving the documentation
12+
- Writing code which can be incorporated into MyPackage itself
13+
14+
### Reporting Bugs
15+
16+
Bugs are tracked as GitHub issues. To report a bug, create an issue and use our bug report template to provide all the necessary information.
17+
18+
### Suggesting Enhancements
19+
20+
This section guides you through submitting an enhancement suggestion for MyPackage, including completely new features and minor improvements to existing functionality. Use our feature request template to submit a feature request.
21+
22+
### Pull Requests
23+
24+
Here's how you can make a pull request (PR) to the project:
25+
26+
1. Fork the repo and create your branch from `main`.
27+
2. If you've added code that should be tested, add tests.
28+
3. Ensure your code adheres to the existing style to maintain the project's consistency.
29+
4. Issue that pull request!
30+
31+
## Coding Guidelines
32+
33+
MyPackage follows the [Microsoft C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions). Please ensure your code contributions adhere to these standards.
34+
35+
## Local Development
36+
37+
As this project is a Unity Package I find the best way to develop it is to create a new Unity project and add the package as a local package. This allows you to test the package in a real Unity environment.
38+
My personal preference is to clone the repo and simlink the package into the Unity project's Packages folder. This allows me to easily make changes to the package and test them in the Unity project.
39+
40+
## Community and Behavioral Expectations
41+
42+
Respect our code of conduct, be kind to each other, and help out with the project. We want a healthy and welcoming community.
43+
44+
## License
45+
46+
By contributing to MyPackage, you agree that your contributions will be licensed under MIT.
47+
48+
## Questions?
49+
50+
If you have any questions, please feel free to contact paul@nonatomic.co.uk
51+
52+
Thank you for contributing to MyPackage.

CONTRIBUTING.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Editor.meta

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"name": "com.nonatomic.mypackage.editor",
3+
"rootNamespace": "Nonatomic.MyPackage",
4+
"references": [
5+
"com.nonatomic.mypackage.runtime"
6+
],
7+
"includePlatforms": [
8+
"Editor"
9+
],
10+
"excludePlatforms": [],
11+
"allowUnsafeCode": false,
12+
"overrideReferences": true,
13+
"precompiledReferences": [],
14+
"autoReferenced": true,
15+
"defineConstraints": [],
16+
"versionDefines": [],
17+
"noEngineReferences": false
18+
}

Editor/com.nonatomic.mypackage.editor.asmdef.meta

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

LICENSE

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

0 commit comments

Comments
 (0)