Unity Release Announcements and Notes

Hello all, we will be using this thread to announce each version release, with notes.

As you have issues/comments/concerns with the Localization System, please create new threads, as this one will be locked for just release announcements.

Our current release is 1.0.0-pre.10
This release is intended for 2019.4 and above

Release notes are available at:
https://docs.unity3d.com/Packages/com.unity.localization@1.0/changelog/CHANGELOG.html

Quick install link:
https://docs.unity3d.com/Packages/com.unity.localization@1.0/manual/Installation.html

Be sure to read the Documentation

 

Hello. Update 0.2.2-preview is available.
This release is a hotfix for the NullRefException on the Asset Tables Window.

Fixed NullRefException when opening the Asset Tables window and no Asset Tables exist in the project

Change the manifest file to say "com.unity.localization": "0.2.2-preview"

 

Hello. Update 0.2.3-preview is now available.
This contains some fixes but is predominantly for those who requested a version that supports the latest Addressables.

• Fixed adding Locales and Tables to Addressables not working when the Addressables settings asset did not exist(LOC-24).
• Fixed exception when changing a table name in the Table Editor window.
• Fixed AssetTablesField exception when no Asset Tables exist in the project.
• Updated to Addressables version '0.5.3-preview'

Change the manifest file to say "com.unity.localization": "0.2.3-preview"

 

Hello. Update 0.3.1-preview is now available.
This contains a new feature(Key Database) and updates to the latest Addressables.

• Added KeyDatabase. All string keys are now contained within this and mapped to a unique(to the database) id value which is used by the table.
• Assets are now grouped in Addressables by the locale. This allows you to serve them on-demand for a particular language, instead of bundling them with the game release. Shared assets are stored in a separate group.
• Assets are now removed from Addressables when they are not referenced by any Asset Tables.
• Fixed UIElements issues in 2019.1+.
• Merged LocalizationPlayerSettings into LocalizationEditorSettings.
• Removed AddressableAssetTableT.GetAsset. GetAssetAsync should be used instead.
• Added option in Asset Tables Windows to add a missing table if a table does not exist for all available Locales.
• Updated to support Addressables version '0.6.8-preview'.
• Fixed UIElements compilation issues in 2019.1+
• Updated to Addressables version '0.7.5-preview'.
• Removed support for .Net 3.5, this is due to a limitation in Addressables.

Change the manifest file to say "com.unity.localization": "0.3.1-preview"

Addressables 0.7.5 now requires the player data to be built manually.
This can be done through the Addressables window Window/Asset Management/Addressable Assets by clicking Build/Build Player Content.

 

Hello. Update 0.3.2-preview is now available.

It includes the following changes:

• Added support for ugui package in 2019.2.0a15. ugui support is optional and will be enabled automatically if the ugui package is in the project.
• Removed support for 2018.3. The ugui support requires optional assemblies which are not supported in 2018.3. We will look at adding 2018.3 support back in the future.
• AssemblyScannerCache now uses UnityEditor.TypeCache in 2019.2 which should provide improved performance in Editor.
• Added an error when adding non-persistent assets to asset tables.
• Fixed StringTableEditor changes being lost due to not setting the table dirty.

Change the manifest file to say "com.unity.localization": "0.3.2-preview"

 

Hello. Update 0.4.0-preview is now available.

This release is intended for 2019.1+

It includes the following changes:

• Added AutoUpdate to LocalizedStringReference class. When enabled, the string will automatically be loaded any time a change is detected and the UpdateString event can be used to update the string. With AutoUpdate enabled calling GetLocalizedString is not necessary.
• Fixed StringTableEditor changes being lost when using inline editing.
• Fixed LocalizationBehaviour not updating the first time when LocalizationSettings are already initialized.
• Fixed LocalizationBehaviour not updating correctly if the asset or table has already been loaded.
• Improved drop down label in LocalizedStringReferencePropertyDrawer. Multi line text is now correctly shown. (LOC-57)
• Added KeyDatabase.FindSimilarKey. Returns the closest match using a Levenshtein approximation.
• Improved key matching when using Localize context menu for Text components.
• Updated to Addressables version '0.8.6-preview'.

Change the manifest file to say "com.unity.localization": "0.4.0-preview"

 

Hello. Update 0.5.0-preview is now available.
This is a big update and is not compatible with 0.4.0 or earlier.

This release is intended for 2019.3+

Edit Packages/manifest.json and insert the package into the dependencies section:
"com.unity.localization": "0.5.0-preview",

Documentation will be available here shortly: https://docs.unity3d.com/Packages/com.unity.localization@0.5/manual/index.html

It includes the following changes:

• Updated to Addressables version *1.2.4-preview*.
• Removed type specific asset tables. The AssetTable class can now hold mixed types per entry.
• Removed Custom Locale support from Locale Generator Window. You should use Metadata to modify the Locale instead.
• Removed Preload behaviour from Localization Settings. Preload behaviour can now be controlled per table through the Asset Tables Window.
• Removed Addressable tests. These would cause issues when run in a project already using Addressables. They have been moved to an internal test suite.
• Removed *Key Database* field from *New Table* panel. Key databases should not be shared now as they act as the Table Name Guid.
• Added Metadata to Locale, LocalizedTable and TableEntry. Metadata can be used to add additional data that implements the IMetadata interface and is serializable.
• Added PreloadAssetTable Metadata. Add this to an AssetTable to configure the preload behaviour for individual assets contained in the table. By default the assets will not be preloaded if this is not present.
• Added PreloadAsset Metadata. Add this to Asset Table entries when using PreloadBehaviour.PreloadSelected to select the entry for preloading.
• Added Comment Metadata. This can be added to any Metadata to provide comments. In the future these comments will be extracted when exporting to external formats.
• Added SmartFormat for StringTables. This allows for advanced formatting of strings. Comes with support for named placeholders, lists, pluralization, gender, code reflection support and much more.
• Added Table Name Guid. Table Names can now be referenced by a Guid so that changes to the name do not break references.
• Fixed Locale Generator Window button `Generate Locales` staying disabled when using `Select All`.
• LocaleGeneratorListView now shows Locales that are already in the project.
• New Locales are now added to Addressables when created.
• Changed the name format for Tables for Addressables and asset creation to start with the name followed by the locale.
• Improved LocalizedString editor. It is now possible to modify the selected entry details in the Inspector without opening the Asset Tables Window.
• Moved Localization Table editor window option to *Window/Asset Management/Localization Tables*.

Known issues
There are some known issues in this version due to using the SerializeReference feature. These issues should be addressed with updates in 2019.3 during the beta.

• Crashing in player builds due to corrupted globalmanager asset.
• Changing any values in the LocalizationSettings during play mode will cause any values using a SerializeReference field(most of them) to be reset resulting in a lot of null references and various errors.
• When modifying values in the Table Editor an error will sometimes be thrown regarding Undo and diff, this will prevent Undo working for that operation and can cause the data to be lost during Serialization.
• String.Format does not work with SmartObjects

 

Hello. Update 0.5.1-preview is now available.

This release is intended for 2019.3+

It includes the following changes:

• Updated to Addressables version 1.3.8.
  
• Fixed ArgumentOutOfRangeException: in the Tables window when only 1 string or asset table existed.
• Exposed CreateAssetTableCollection in LocalizationEditorSettings.
• Implemented IDictionary to LocalizedTableT and Removed TableEntries property.
• Fixed LocalizedTableT not serializing changes made when using the Dictionary interface.
• Added LocalizedTableT.CreateTableEntry, this should be used when creating a StringTableEntry or AssetTableEntry.
• ArgumentNullException is now thrown when using a null ChangeHandler with LocalizedString.RegisterChangeHandler or LocalizedAsset.RegisterChangeHandler.
• Fixed PluralLocalizationFormatter using the Selected Locale when a CultureInfo provider was used.
• Current loading operations are now cleared when using ClearChangeHandler with LocalizedAsset and LocalizedString
• Added default constructor to FallbackLocale Metadata.
• Fixed error spamming when adding Metadata that does not have a default constructor.
• Removed missing image from LocalizationTablesWindow manual page.

Change the manifest file to say "com.unity.localization": "0.5.1-preview"

 

Hello. Update 0.6.0-preview is now available.

This release is intended for 2019.3+

It includes the following changes:

Added

• Added PseudoLocale and Pseudo-localization methods(Accenter, CharacterSubstitutor, Encapsulator and Expander). This is used to generate Pseudo-localization using various methods during runtime(See docs for further info).
• Added support for loading multiple Locales from String and Asset Databases. By Default the LocalizationSettings.SelectedLocale will be used however it is now possible to provide a Locale as an argument. This means Localization data for multiple Locales can exist which allows for fallback Locales or just showing multiple languages at once.
• Added exception to LocalizedTable.TableName if the SharedTableData is null.
• Added Locale Generator button to New Table tab.

Changed

• Renamed KeyDatabase to SharedTableData.
• Changed Comment metadata TimeStamp property type to DateTime.
• Disabled Addressables Settings asset creation during Localization OnPostprocessAllAssets. This could cause corruption of Addressables data due to OnPostprocessAllAssets execution order when importing a project for the first time.
• Updated to Addressables version 1.5.1.
• Addressable groups now use the NoHash BundleNamingStyle by default.

Fixed

• Fixed NullReferenceException sometimes being thrown by LocalizedString or LocalizedAsset during ClearLoadingOperation.
• Fixed NullReferenceException when adding SmartFormatter Source in String Database inspector.
• Fixed ArgumentOutOfRangeException: in StringTables when enabling a Missing Tables column.
• Fixed LocalizedReference field label overflowing when a selected key had multiple lines.
• Fixed LocalizedString property drawer adding too much vertical whitespace.
• Fixed items in Reorderable Lists ignoring the right border.
• Fixed LocalizedTableT entry Id not being updated when entry was moved or removed.
• Fixed GameViewLanguageMenu causing LocalizationSettings to Initialize when there was no Addressables/Locales in the project.
• Fixed Key name being unchangeable when its name was empty in the Asset Tables window.
• Fixed Search field border being too small in the Asset Tables Window.
• Fixed New Table - Create button being enabled when no locales were selected or existed in the project.
• Fixed LocalizedString and LocalizedAsset not automatically updating when the TableReference or TableEntryReference was changed and a ChangeHandler was being used.
• Fixed Addressable flags including Preload being removed during AddOrUpdateTable.

Change the manifest file to say "com.unity.localization": "0.6.0-preview"

Documentation https://docs.unity3d.com/Packages/com.unity.localization@0.6/manual/index.html

 

Hello,
0.6.1-preview is now available. This contains a few bug fixes.

Added

• IEquatable to LocaleIdentifier.

Changed

• Changed collection properties to be read only (rule CA2227).

• Made AddressableEntryNotFoundException public.

Fixed

• Fixed LocalizedAssetTexture and LocalizeAudioClipBehaviour not serializing the asset reference field. (case 1216072)
  
• SystemLocaleSelector will now check the CultureInfo before checking Application.SystemLanguage to allow for selecting regional languages first.

To install you can either select Update to 0.6.1 in the package manager(if you already have the Localization package installed) else change the manifest file to say "com.unity.localization": "0.6.1-preview"

 

Hello,
0.7.1-preview is now available.
This contains bug fixes and Google Sheets support.

Change the manifest file to say "com.unity.localization": "0.7.1-preview"

Documentation https://docs.unity3d.com/Packages/com.unity.localization@0.7/manual/index.html

Upgrading
We have introduced a new editor only type StringTableCollection and AssetTableCollection. Tables will only show up in the editor if they are not part of a collection. To upgrade an existing project just click on one of the table assets and click the Create Collection button.

Added

• Added StringTableCollection and AssetTableCollection. These are editor only assets for controlling a collection of string or asset tables. Tables that are not part of a collection will now be ignored. To upgrade old table assets select one and press the Create Collection button in the inspector.
• Added Google Sheets support. A StringTableCollection can by pushed and pulled by using the Google Sheets Extension in the editor or through script with the GoogleSheets class. Table entry values, comments and metadata can be synced to a Google Sheet. This is currently an Editor only feature.
• Added DisplayName attribute. This is an optional attribute for Metadata and CollectionExtensions so that a custom name that can be displayed in the editor instead of the class name.
• Added LocalizationSettings.SelectedLocaleAsync. This is a safer alternative to LocalizationSettings.SelectedLocale as it will ensure that the AvailableLocales is initialized.

Changed

• Renamed LocalizeStringBehaviour to LocalizeStringEvent.
• Renamed LocalizeAudioClipBehaviour to LocalizeAudioClipEvent.
• Renamed LocalizeTextureBehaviour to LocalizeTextureEvent.
• Renamed TableName to TableCollectionName.
• The editor class AssetTableCollection has been repurposed. Please see the new StringTableCollection and AssetTableCollection assets.
• LocalizationEditorSettings has changed:
  • Replaced ModificationEvent with EditorEvents class
  • AddAssetToTable and RemoveAssetFromTable have been moved to AssetTableCollection
  • Added GetStringTableCollection, GetStringTableCollections, GetAssetTableCollection and GetAssetTableCollections.
  • Removed RemoveTable, GetAssetTables, GetAssetTablesCollection. These features are replaced by StringTableCollection and AssetTableCollection.
  • Simplified ILocalesProvider interface Only 1 GetLocale function is now required.
  • Updated code Samples to include Creating Locales, Loading Strings, Google Sheets and a Language selection menu example.

Fixed

• Fixed Asset Tables Window throwing NullReferenceException when editing Metadata for an entry that does not exist in the selected table.
• Fixed incorrect installation instructions in documentation.
• Fixed SerializedTableEntryReference not handling key names correctly, which could cause issues with LocalizedString and LocalizedAsset. (case 1230444)
• Fixed TableReference returning invalid value for TableName when type is Guid.
• Fixed UpdateString not being called When a new LocalizedString was assigned to LocalizeStringEvent.StringReference.
• Fixed UpdateAsset not being called When a new LocalizedAsset was assigned to LocalizeStringEvent.AssetReference.
• Fixed LocalizedString and LocalizedAsset trying to localize when they are empty. (case LOC-88)
• Localized String editor now clips Locale labels instead of letting them overlap into the preview label. (case LOC-84)
• Fixed Available Locales List is not updating when a Locale is added or removed from the project. (case LOC-79)
• Fixed LocalizedAsset and LocalizedString editor not updating when a Locale is added or removed from the project.
• Fixed SharedTableData Metadata child properties not being visible or editable in the Table Window. (case LOC-85)
• Fixed Smart Format toggle field overflowing into Metadata button when Table Window columns were narrow. (case LOC-95)
• Fixed LocalizedStringDatabase and LocalizedAssetDatabase using the SelectedLocale before AvailableLocales was initialized. (case 1225937)
• Fixed Asset Tables losing data due to not being set dirty when a change was made. (case LOC-82)
• Fixed ListFormatter Names property going null in player builds.

 

Hello,
0.8.0-preview is now available.

Change the manifest file to say "com.unity.localization": "0.8.0-preview"

Documentation: https://docs.unity3d.com/Packages/com.unity.localization@0.8/manual/index.html

We are also doing some User Research for the package and would love to hear from you! https://forum.unity.com/threads/use...opers-for-60-minute-remote-interviews.951077/

0.8.0-preview contains the following changes:

Added

• Added IKeyGenerator to SharedTableData. This is now used to generate unique ids for each key. By default, DistributedUIDGenerator will be used to generate the keys however it is possible to change it back to Sequential by assigning SequentialIDGenerator to SharedTableData.KeyGenerator. See docs for further details.
• Added PreserveTags Pseudo-localization method. This will prevent tags such as rich text or XML from being modified by any subsequent Pseudo-localization methods. (LOC-86)
• Added LocalizeSpriteEvent component. This can be used for Localizing Sprite assets.
• Added Localize context menu item for UGUI Image component. This will add and set up a LocalizeSpriteEvent component.
• Added Group property to StringTableCollectionand AssetTableCollection, This can be used to customize the menu grouping when selecting a Table Collection.
• Locales can now be sorted in the Localization project settings view.
• Added SortOrder property to Locale. This can be used to override the default sorting order. This value is set automatically when changing the order in the editor.
• Added CheckForMissingSharedTableDataEntries to StringTable and AssetTable. This will find any entries in the table that are missing matching Shared Table Entries. These missing entries can be repaired with the MissingEntryAction parameter.
• Added RemapKey to SharedTableData. This will let the Id of a key be changed.
• Added LocalizedStringTable and LocalizedAssetTable. These work in a similar way to LocalizedString and LocalizedAsset but will return a Table instead of a single table entry.
• Added new Sample: Simple Language Selection Menu (IMGUI). Includes 2 different examples of a Locale selection menu.

Changed

• Changed Table Entry Key Id data type from uint to long. All Methods that were using a uint now require a long integer.
• IPseudoLocalizationMethod method Transform now passes a Message instead of a string.
• The Locale column order in the Localization Tables window is now determined by the Locale's order.
• Upgraded to latest Newtonsoft Json package 2.0.0.
• Renamed LocalizedTable to LocalizationTable.
• Renamed LocalizedTableT to DetailedLocalizationTable
• Renamed LocalizedTableCollection to LocalizationTableCollection
• Improved error message when a Locale can not be selected during initialization.
• Replaced LocalizedString RegisterChangeHandler and ClearChangeHandler with the event StringChanged.
• Replaced LocalizedAsset RegisterChangeHandler and ClearChangeHandler with the event AssetChanged.

Fixed

• Fixed StringTableCollection assets not being set dirty when pulling from a Google Sheet in the editor. (1240528)
• Fixed StringTableCollection assets not being set dirty when pulling from a Google Sheet in the editor.
• Fixed LocalizedString.GetLocalizedString not using the argument provided in LocalizedString.Arguments.
• Fixed `serialization errors Should not occur! Internal logic error: please report bug`. when Comment Metadata was attached to the table or shared table data. (LOC-104)
• Fixed LocalizedDatabase.GetTableAsync trying to load an already loaded LocalizedTable when using a GUID TableReference. This was causing preloaded tables to still require some loading.
• Fixed "LocalizationSettings has a different serialization layout" error. Moved the Locale GameView Menu property from LocalizationSettings to EditorPrefs and moved the menu option into Preference/Localization. (LOC-99)
• Fixed GoogleSheets push not handling Table entries that were missing matching Shared Table Entries, this would cause future rows to be blank. (LOC-102)
• Fixed NullReferenceException in Localization Settings when Editor window focus was lost and Smart Format properties field was visible. (LOC-101)
• Fixed Available Locales not updating when performing an Undo/Redo after adding or removing a Locale.
• LocalizedString and LocalizedAsset property drawers now remember the expanded state of each Locale field when an Undo/Redo occurs. (LOC-105)
• Added Undo support when adding and removing a table from a StringTableCollection or AssetTableCollection. When Undo is not used the asset will be set dirty so changes are not lost. (LOC-107)

 

Hello,

This is a patch release to fix a breaking issue in 0.8.0-preview.

Change the manifest file to say "com.unity.localization": "0.8.1-preview" or press update in the Package Manager if you are already using the package.

Documentation: https://docs.unity3d.com/Packages/com.unity.localization@0.8/manual/index.html

We are also doing some User Research for the package and would love to hear from you! https://forum.unity.com/threads/use...opers-for-60-minute-remote-interviews.951077/

0.8.1-preview contains the following changes:

Fixed

• Fixed incorrect Further Reading URL in Pseudo-Localization documentation page.
• Fixed changes to tables not being saved due to them not being set dirty when edited through the Table Editor.

 

Hello,
0.9.0-preview is now available.

To upgrade change the manifest file to say "com.unity.localization": "0.9.0-preview" or click add gitHub Url and type com.unity.localization.

Documentation: https://docs.unity3d.com/Packages/com.unity.localization@0.9/manual/index.html

0.9.0-preview contains the following changes:

Added

• Added support for exporting and importing StringTables and StringTableCollections as XML Localisation Interchange File Format (XLIFF). XLIFF version 1.2 and 2.0 are both supported. See docs for further details.
• Added support for exporting and importing StringTableCollections as Comma Separated Values (CSV).
• Added GetRowEnumerator to AssetTableCollection and StringTableCollection. This can be used to step through each key and its localized values.
• Added ReleaseAssets to allow for forcing all AssetTable assets to be released. This is called automatically when the LocalizationSettings.SelectedLocale is changed.

Changed

• Updated to Addressables version 1.16.6.
• Editor Foldout fields now toggle when clicking on the label.
• When enabling preload on Asset Tables, all assets will now be preloaded by default instead of requiring the PreloadAssetTable Metadata. Adding a PreloadAssetTable can be used to disable this default behavior. (LOC-114)
• SmartFormat editor will now show parsing and format errors in the preview field.
• Added title header to Google Sheets extension property drawer.

Fixed

• Fixed smart StringTableEntry returning the wrong localized string after its value was changed.
• Fixed LocalizedAsset from loading when it contained an empty reference. (LOC-109)
• Fixed InvalidCastException when calling AssetTable.GetAssetAsync and the table was preloaded. (LOC-114)
• Fixed bug in PreloadDatabaseOperation that caused it to complete before preloading was finished. (LOC-114)
• Fixed Tables Window throwing exceptions when editing a collection which had 1 or more tables without a matching locale in the project.
• Fixed ProjectSettings.asset being modified on disc during a build.
• Fixed LocalizedString property drawer throwing NullReferenceException when selecting a Localization Table Collection which did not have a table for every Locale in the project. (LOC-118)
• Calling AddKey will now check if the new Id is already in use and generate a new Id if it is. This means it is now safe to use custom Id values.
• SharedTableData that contains an empty Guid will now be repaired when loaded in the editor.
• Fixed SmartFormat editor becoming corrupt when showing preview and ThrowException action was enabled in ParseError or FormatError. [(LOC-119)(https://issuetracker.unity3d.com/is...ing-and-throwexceptions-error-mode-is-enabled)]
• Increased max width for Localization Tables window Id field so large keys can be fully visible.

 

Hi,

Localization version 0.10.0-preview is now available.

Release notes are available at:
https://docs.unity3d.com/Packages/com.unity.localization@0.10/changelog/CHANGELOG.html

Quick install link:
https://docs.unity3d.com/Packages/com.unity.localization@0.10/manual/Installation.html

 

Hi,

Localization version 0.11.0-preview is now available.

This version includes some changes to the default Addressables groups. If you are upgrading a project you can keep the behaviour by creating the asset Assets/Create/Localization/Addressable Group Rules (Legacy)
Alternatively, you can upgrade to the new groups by running the 3 Localization Analyzers in Windows/Asset Management/Addressables/Analyze

Release notes are available at:
https://docs.unity3d.com/Packages/com.unity.localization@0.11/changelog/CHANGELOG.html

Quick install link:
https://docs.unity3d.com/Packages/com.unity.localization@0.11/manual/Installation.html

 

Hi we just pushed out a patch release that adds support for entering play mode with domain and scene reload disabled.

0.11.1-preview

 

Hi!
We have moved from being a preview package to a pre-release package!
The next release is 1.0.0-pre.8
This is almost the same as 0.11.1-preview but with a few small changes, we had to make to get into pre-release.

The package should be publicly visible in the next release of 2021.2 alpha (2021.2.a18).
We still support 2019.4+ and plan to continue supporting it but won't be publicly visible on the package manager for the time being, just in 2021.2.

We will be releasing future updates as 1.0.0-pre.x until ready to transition to our first release. We still plan to land the localized property variants feature we showed at the December Webinar during this period.

 

Hi,

Localization version 1.0.0-pre.9 is now available.
We were waiting for 1.0.0-pre.8 to land before we could push the latest changes out so this is the latest release

This includes support for Synchronous Workflows, so you can now force an operation to complete on the main thread by calling WaitForCompletion.

Release notes are available at:
https://docs.unity3d.com/Packages/com.unity.localization@1.0/changelog/CHANGELOG.html

Quick install link:
https://docs.unity3d.com/Packages/com.unity.localization@1.0/manual/Installation.html

 

Hi,

Localization version 1.0.0-pre.10 is now available.

This includes the Localized Property Variants feature we showed during the December Webinar. Note this feature is only available in Unity 2020.3 and above.

Release notes are available at:
https://docs.unity3d.com/Packages/com.unity.localization@1.0/changelog/CHANGELOG.html

Quick install link:
https://docs.unity3d.com/Packages/com.unity.localization@1.0/manual/Installation.html