Bodix/Unity-Project-Template

Default template for Unity projects

Project Name

Project description, purposes, etc.

Requirements

• Unity: 2020.3.15f1
• Platforms:
  • Android
  • iOS

Packages

• Zenject - for dependency management
• TextMesh Pro - for text components (instead of UnityEngine.UI.Text)
• Evolunity - for speed up development (extensions and utilities)
• Lunar Console - for console on mobile devices

Possible packages (not installed)

Packages that can be installed into the project to solve common problems.

• ARFoundation (3.0.1) - for AR
  • ARCore (3.0.4) - for supporting AR on Android
  • ARKit (3.0.4) - for supporting AR on iOS
• Unity UI Extensions - for advanced UI elements
• Modern UI Pack - for advanced UI elements
• Lean Touch - for gestures handling
• Lean Pool - for object pooling
• DOTween - for animations from code
• Quick Outline - for outlining selected AR effects
• NatCorder - for video recording in runtime
• Ultimate LOD System MT - for LOD system
• Safe Area Helper - for convenient handling different safe areas
• Unity Native Share - for sharing feature
• GLTFUtility - for GLTF/GLB support
• UniWebView 4 - for playing YouTube video
• YouTube Data API v3 - for retrieving data from YouTube
• UniTask - for async operations
• NuGetForUnity - for using NuGet packages

References

• Google Drive
• Jira

Using

1. Clone repository.
2. Rename project folder.
3. Update README.md.
   • Update name.
   • Update description.
   • Update Unity version (if needed).
   • Update platforms (if needed)
   • Update packages.
   • Remove Possible packages section.
   • Update references.
   • Remove Using section.
4. Update Project Settings in Unity.
   • Player tab:
     • Update Company Name (if needed).
     • Update Product Name.
     • Update Package Name (lowercase).
       • com.companyname.productname
   • Editor tab:
     • Update Root namespace.
5. Update namespace in the scripts (according to the Root namespace).
6. Recreate git repository.
   • Remove .git folder (may be invisible).
   • Initialize new repository.
     • git init
   • Add new remote.
     • git remote add origin <URL>
   • Create new commit.
     • git add -A
     • git commit -m "Add project files"
   • Push master branch to remote.
     • git push --set-upstream origin master
   • Create and checkout develop branch.
     • git checkout -b develop
   • Push develop branch to remote.
     • git push --set-upstream origin develop