.asmdef

Unity 3D assembly definition file

Type object
File match *.asmdef
Schema URL https://catalog.lintel.tools/schemas/schemastore/asmdef/latest.json
Source https://www.schemastore.org/asmdef.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Defines an assembly in the Unity compilation pipeline

Properties

name string required

The name of the assembly being defined

minLength=1
rootNamespace string

The root namespace of the assembly. Requires Unity 2020.2

references string[]

A list of assembly names or assembly asset GUIDs to reference

uniqueItems=true
includePlatforms enum[]
uniqueItems=true
excludePlatforms enum[]
uniqueItems=true
allowUnsafeCode boolean

Allow unsafe code

Default: false
autoReferenced boolean

When true, this assembly definition is automatically referenced by predefined assemblies (Assembly-CSharp, Assembly-CSharp-firstpass, etc.)

Default: true
noEngineReferences boolean

When true, no references to UnityEngine or UnityEditor will be added to this assembly project

Default: false
overrideReferences boolean

When true, any references to precompiled assembly assets are manually chosen. When false, all precompiled assembly assets are automatically referenced

Default: "false"
precompiledReferences array

A list of precompiled assembly assets that will be referenced. Only valid when overrideReferences is true

uniqueItems=true
defineConstraints array

A list of the C# compiler define symbols that must evaluate to true in order for the assembly to be compiled or referenced. Absence of a symbol can be checked with a bang symbol (!DEFINE)

uniqueItems=true
optionalUnityReferences enum[]

Additional optional Unity features to reference

uniqueItems=true
versionDefines object[]

A set of expressions that will define a symbol in the C# project if a package or module version matches the given expression

uniqueItems=true

Any of

1. variant
includePlatforms
minItems=1
excludePlatforms
maxItems=0
2. variant
includePlatforms
maxItems=0
excludePlatforms
minItems=1
3. variant
includePlatforms
maxItems=0
excludePlatforms
maxItems=0

Definitions

platformValues enum[]