The Assembly Definition (.asmdef
) asset allows you to define a new assembly by placing it in the root of a folder containing scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary.
The Assembly Definition Reference (.asmref
) asset allows you to explicitly include a set of script files into a preexisting assembly.
To create an Assembly Definition asset:
Unity recompiles the scripts in the project to create the new assembly. You can then edit the properties of the new Assembly Definition.
The new assembly includes all scripts in the same folder as the Assembly Definition plus those in any subfolders that don’t have their own Assembly Definition or Reference file. Unity removes scripts from their previous assembly where applicable.
To create an Assembly Definition Reference asset:
In the Project window, locate the folder containing the scripts you want to include in the referenced assembly.
Create an Assembly Reference asset in the folder (menu: Assets > Create > Scripting > Assembly Definition Reference).
Assign a name to the asset.
Unity recompiles the scripts in the project to create the new assembly. Once it has finished, you can edit the properties of the new Assembly Definition Reference.
Select the new Assembly Definition Reference asset to view its properties in the Inspector.
Set the Assembly Definition property to reference the target Assembly Definition asset.
Click Apply.
The referenced assembly now includes all scripts in the same folder as the Assembly Definition Reference, plus those in any subfolders that don’t have their own Assembly Definition or Reference file. Unity removes scripts from their previous assembly where applicable.
To create an assembly for a specific platform:
Select the new Assembly Definition Reference asset to view its properties in the Inspector.
Check the Any Platform option and choose specific platforms to exclude. Alternately, you can uncheck Any Platform and choose specific platforms to include.
Click Apply.
The assembly will be included (or excluded) according to the selected platforms when you build your project for a platform.
Editor assemblies allow you to put your Editor scripts anywhere in the project, not just in top-level folders named Editor
.
To create an assembly that contains the Editor code in your project:
Test assemblies are assemblies which Unity expects to contain tests. Putting your tests in test assemblies has the following benefits:
Unity automatically identifies any assembly as a test assembly if it has an assembly reference to nunit.framework.dll and assembly definition references to UnityEngine.TestRunner and UnityEditor.TestRunner.
Refer to the Unity Test Framework documentation for instructions on installing the Test Framework package and creating test assemblies. You can use the Editor UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary to create an assembly definition file with the relevant references predefined, or you can configure the references manually through the Inspector window or by editing the JSON file directly.
Note: Test assemblies are not compiled as part of the regular build pipeline, so any code placed in a test assembly will be excluded from a standard project build. Your test assembly code will only be included in a Player when you run Play Mode tests in a Player through the Test Runner window. If you have production code that unexpectedly doesn’t compile into your project build, double-check to make sure it’s not in a test assembly.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.