Unity Manual

Language : English

Unity 6.2 Beta User Manual
- Documentation versions
- Offline documentation
- Trademarks and terms of use
What's new in Unity
- New in Unity 6.1
- New in Unity 6.0
- New in Unity 6.0 Preview
- New in Unity 2023.2
- New in Unity 2023.1
Unity for first-time users
- Create your first project
- 2D and 3D projects
- Getting started with AI in Unity
- Key concepts
- Best practice guides
Install and upgrade
- Install Unity
- Deploy Unity across your enterprise
  - Enable Unity installation by standard users (Windows)
  - Use Unity through web proxies
- Licenses and activation
- Upgrade Unity
The Editor interface
- The Project window
- The Scene view
  - Overlays
  - Scene view grid snapping
  - Pick and select GameObjects in the Scene view
  - Position GameObjects
  - Scene view navigation
  - Scene view Camera
  - Control a camera in first person
  - Scene visibility
  - Scene view Draw Modes and View Options overlays
  - Gizmos and handles
    - Gizmos menu
    - Programming with gizmos and handles
  - Scene view context menu
  - Custom Editor tools
- The Game view
- Device Simulator
  - Device Simulator introduction
  - The Simulator view
  - Simulated classes
  - Adding a device
  - Extending the device simulator
- The Hierarchy window
- The Inspector window
  - Manage the Inspector window
  - Inspect items
  - Focus an Inspector window
  - Assign icons to inspected items
  - Manage components and their values
- The Toolbar
  - The AI menu
- The status bar
- The Background Tasks window
- Console window
- Additional windows
- Undo
- Search in the Editor
- Customizing your workspace
- Preferences
- Keyboard shortcuts
  - Keyboard shortcut concepts
  - Shortcuts window reference
  - Manage keyboard shortcuts
  - Manage shortcut profiles
- Project Settings
  - Use the Project Settings window
  - Audio
  - Editor
  - Graphics
  - Package Manager
  - Physics
  - Physics 2D reference
  - Player
    - Splash Image Player settings
  - Preset Manager
  - Quality settings tab reference
  - Script Execution Order reference
  - Services
    - Diagnostics
  - Tags and Layers
  - Time
  - UI Toolkit project settings
  - Version Control
- 2D and 3D mode settings
- Save your work
- Editor analytics
- Troubleshoot the Editor
- Unity Search
  - Launch and use the Search window
  - Act on search results
  - Manage results tables
  - Focus searches with search providers
    - Use search providers
    - Activate and deactivate search providers
  - Search provider references
  - Visual query builder reference
  - Textual query references
  - Manage search queries
    - Invoke from the main menu
  - Create a custom search provider
  - Manage search indices
Packages and package management
- Get started with packages
- Dependencies
- The Package Manager window
- Package management with the Package Manager window
- Package management with the scripting API
  - Scripting API for packages
  - Access package assets using scripts
- Package management with the project manifest file
  - Project manifest file
- Package inspection
  - Package Manifest window reference
  - Inspect packages
- Packages
- Feature sets
- Git dependencies
  - Use private repositories with HTTPS Git URLs
  - Use passphrase-protected SSH keys with SSH Git URLs
- Package Manager caches
- Scoped registries
- Package Manager configuration
  - Configuration files
  - Configure your network for Package Manager
- Create custom packages
- Package Manager troubleshooting
  - Diagnose network issues
Assets and media
- Introduction to assets in Unity
- Importing assets
- Caching assets
- Managing assets with the Asset Database
- Reusing settings with preset assets
- Managing assets at runtime
- Scripting with assets
  - Stream assets directly into a build
  - Modify source assets from code
- Distribute assets as packages
- Analyzing asset processes
- Unity's Asset Store
2D game development
- Introduction to 2D
- Get started with 2D game development
- 2D renderer sorting
- Sprites
- Tilemaps in Unity
- 2D physics
- 2D game development in URP
  - 2D lighting in URP
  - Precise pixel scaling and rotation via the Pixel Perfect Camera in URP
Get started with 3D game development
XR
- Overview
- XR project set up
- Run an XR application
- XR graphics
- XR audio
  - Audio spatializers in XR
- Unity XR SDK
Multiplayer
- Unity multiplayer overview
- Use the Multiplayer Center
Platform development
- Cross-platform features and considerations
- Android
- Dedicated Server
- Embedded systems
- iOS
- Linux
- macOS
- tvOS
- Universal Windows Platform
- visionOS
- Web
- Windows
GameObjects
- Introduction to GameObjects
- GameObject fundamentals
- Primitive and placeholder objects
  - Types of 2D primitive GameObjects
- Components
- Models
  - Creating models outside of Unity
  - Importing models into Unity
- Meshes
- Prefabs
- Constraints
Scenes
- Introduction to scenes
- Creating, loading, and saving Scenes
- Work with multiple scenes in Unity
- Scene Templates
- Layers
- Tags
- Text-based Scene files
Cameras
- Introduction to cameras
- The camera view
- Using multiple cameras
- Changing resolution scale
  - Introduction to changing resolution scale
  - Dynamic Resolution
- Excluding hidden objects with occlusion culling
- Simulating real-world cameras with Physical Cameras
- Camera output
- Cameras in URP
- Cameras in the Built-In Render Pipeline
  - Set the camera background with Clear Flags in the Built-In Render Pipeline
  - Camera Inspector window reference for the Built-In Render Pipeline
- Troubleshooting cameras
World building
- Sky
- Terrain
- Terrain and the Terrain Tools package
Physics
- Built-in 3D Physics
Input
- Mobile Keyboard
- Unity XR Input
- Legacy Input
  - Input Manager
  - Mobile device input
- IME in Unity
UI systems
- Comparison of UI systems in Unity
- UI Toolkit
- Unity UI
- IMGUI (Immediate Mode GUI)
Animation
- Mecanim Animation system
- Legacy Animation system
  - Legacy Animation component
Audio
- Audio overview
- Audio files
- Tracker Modules
- Audio Mixer
- Native audio plug-in SDK
- Audio playlist randomization
- Audio Profiler module
- Ambisonic Audio
  - Develop an ambisonic audio decoder
- Audio Reference
Video and cutscenes
- Video sources
- Video Player
- Video Profiler module
Lighting
- Introduction to lighting
- Lighting configuration workflow
- Light sources
- Direct and indirect lighting
- Shadows
- Reflections
- Lighting in URP
- Lighting in the Built-In Render Pipeline
- Optimize lighting in the Built-In Render Pipeline
- Lighting reference
Materials and shaders
- Materials
- Prebuilt materials and shaders
- Custom textures
- Custom shaders
- Color and High Dynamic Range (HDR)
  - Color spaces
  - High dynamic range (HDR)
- Shader Import Settings window reference
Visual effects
- Particle effects
- Decals
- Lens flares
- Light halos
  - Create and configure a halo light effect
  - Halo component reference
- Lines and trails
  - Rendering lines
  - Rendering trails
- Visual Effect Graph
Render pipelines
- Introduction to render pipelines
- Scriptable Render Pipeline fundamentals
- Choosing a render pipeline
- Rendering paths in Unity
- Using the Universal Render Pipeline
- Using the High Definition Render Pipeline
- Using the Built-In Render Pipeline
Post-processing
- Introduction to post-processing
- Post-processing effect availability reference
- Post-processing and full-screen effects in URP
Programming in Unity
- Get started with programming in Unity
- Environment and tools
  - Integrated development environment (IDE) support
  - Unity .NET features
- Object-oriented development
- Compilation and code reload
- Code optimization
- Testing your code
- Debugging and diagnostics
Optimization
- Memory in Unity
- Unity Profiler
- Profiling tools
- Graphics performance and profiling
Building and publishing
- Build profiles
- Incremental build pipeline
- Visual Studio C# integration
- RenderDoc integration
- Version control
- Command-line arguments
  - Unity Editor command line arguments
  - Unity Standalone Player command line arguments
Unity Services
- Unity IAP
Troubleshooting
Glossary

Platform development
Windows
Develop for Windows
Unity debugging guide for Windows
Configure your debugging tool to debug Unity in Windows

Introduction to debugging Unity in Windows

Set up live debugging for Unity

Configure your debugging tool to debug Unity in Windows

Set up Windows Debugger (WinDbg) or Visual Studio to resolve Unity symbols so you can debug your Unity applications or the Unity Editor.

If your debugging tool is already set up to resolve Unity symbols and you want to know how to set up live or forensic debugging, refer to:

Set up Windows Debugger (WinDbg) to debug Unity

Follow these instructions to configure Windows Debugger (WinDbg) to automatically download and resolve Unity store symbols. When WinDbg has access to these symbols, you can use it to debug your application or the Editor.

Open WinDbg as administrator.
Go to File > Attach to process. A list of applications shows in the window.
In the list, choose the application you want to debug:
- To debug the Editor, use Unity.exe.
- To debug your built game, use the .exe file of your game.
Select Attach. WinDbg connects to your application, which might take a few minutes.
Enter the following into the Command window in WinDbg to add Unity symbols to your debugger:
```
.sympath+ SRV*c:\symbols-cache*http://symbolserver.unity3d.com/
```

As a result, WinDbg is ready to debug your Unity Editor or application.

Detailed breakdown of the code

.sympath+ SRV*c:\symbols-cache*http://symbolserver.unity3d.com/

.sympath+

.sympath on its own sets a new symbol path, which overwrites the previous path. The + addition ignores the existing symbol path, and appends the symbol store lookup.

SRV*c:\symbols-cache

The SRV indicates a remote server to fetch from. The c:\symbols-cache is a local path to cache the downloaded symbols. Before WinDbg retrieves symbols, it checks that path first so it doesn’t download the same symbol multiple times. You can change this path to any directory on your system.

*https://symbolserver.unity3d.com/

This is the URL of the symbol store which your debugging software will fetch from.

Set up Visual Studio to debug Unity

Follow these instructions to configure Visual Studio (2019 or later) to automatically download and resolve Unity store symbols. When Visual Studio has access to these symbols, you can use it to debug applications or the Editor.

Open Visual Studio.
Go to Tools > Options.
Expand the Debugging section and then select Symbols.
Specify a cache directory if not already specified.
Click Add (+). This adds a new symbol location to the Symbol file (.pdb) locations list.
Enter https://symbolserver.unity3d.com/ into the new list entry.

Visual Studio is ready to debug your Unity code.

Additional resources

Did you find this page useful? Please give it a rating:

Report a problem on this page

Introduction to debugging Unity in Windows

Set up live debugging for Unity