# Project

Class in [Yarn.Compiler](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler)

Inherits from `System.Object`

## Summary

Yarn Projects represent instructions on where to find Yarn scripts and associated assets, and how they should be compiled.

```csharp
public class Project
```

## Classes

| Name                                                                                                                                       | Description                                                                                                  |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| [LocalizationInfo](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.localizationinfo) | Stores the locations of where localized assets and a localized string table for a Yarn Project may be found. |

## Fields

| Name                                                                                                                                                         | Description                                        |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
| [CurrentProjectFileVersion](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.currentprojectfileversion) | The current version of `.yarnproject` file format. |

## Methods

| Name                                                                                                                                           | Description                                                                                                                                                    |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [GetJson()](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.getjson)                     | Gets a string containing JSON-formatted text that represents this [Project](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project) . |
| [IsMatchingPath(string)](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.ismatchingpath) | Gets a value indicating whether `path` is a path that is included in this project.                                                                             |
| [LoadFromFile(string)](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.loadfromfile)     | Loads and parses a [Project](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project) from a file on disk.                             |
| [SaveToFile(string)](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.savetofile)         | Saves a [Project](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project) as JSON-formatted text to a file on disk.                   |

## Properties

| Name                                                                                                                                             | Description                                                                                                                                                                                                                                                    |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [BaseLanguage](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.baselanguage)               | Gets or sets the base language of the project, as an IETF BCP-47 language tag.                                                                                                                                                                                 |
| [CompilerOptions](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.compileroptions)         | Gets or sets a dictionary containing instructions that control how the Yarn Spinner compiler should compile a project.                                                                                                                                         |
| [Definitions](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.definitions)                 | Gets or sets the path to a JSON file containing command and function definitions that this project references.                                                                                                                                                 |
| [DefinitionsPath](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.definitionspath)         | Gets the path to the Definitions file, relative to this project's location.                                                                                                                                                                                    |
| [ExcludeFilePatterns](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.excludefilepatterns) | Gets or sets the collection of file search patterns that should be excluded from this project.                                                                                                                                                                 |
| [FileVersion](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.fileversion)                 | Gets or sets the file version of the project.                                                                                                                                                                                                                  |
| [Localisation](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.localisation)               | Gets or sets the collection of [LocalizationInfo](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.localizationinfo) objects that store information about where localized data for this project is found. |
| [Path](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.path)                               | Gets the path that the [Project](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project) was loaded from.                                                                                                                             |
| [SourceFilePatterns](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.sourcefilepatterns)   | Gets or sets the collection of file search patterns used to locate Yarn files that form this project.                                                                                                                                                          |
| [SourceFiles](https://docs.yarnspinner.dev/2.4/api/csharp/yarn.compiler/yarn.compiler.project/yarn.compiler.project.sourcefiles)                 | Gets the collection of Yarn files that should be used to compile the project.                                                                                                                                                                                  |