Skip to content

Commit bc34a6f

Browse files
authored
Update Readme with how to address scoped registry timeouts (#539)
Also: - Wrap some naked URLs in anchors - Improve some wording - Tighten up GitHub alert blocks - Create a parent "Add scoped registry" heading above the two current headings to clarify them as alternatives. - Add comments to the `manifest.json` example so people hopefully don't totally overwrite their files with the example contents.
1 parent 6d991fe commit bc34a6f

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

readme.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,27 @@
55
This project provides a seamlessly integration of a [curated list](registry.json) of NuGet packages within the Unity Package Manager.
66

77
> [!IMPORTANT]
8-
> DISCLAIMER: This is not an official service provided by Unity Technologies Inc.
8+
> This is not an official service provided by Unity Technologies Inc.
99
1010
## Usage
1111

1212
> [!NOTE]
1313
> Feed provided by [OpenUPM](https://medium.com/openupm/openupm-launches-alternative-unitynuget-registry-0b8cc663cc41).
1414
15-
### Add scope registry (manifest.json)
15+
### Add scoped registry
1616

17-
In order to use this service you simply need to edit the `Packages/manifest.json` in your project and add the following [scoped registry](https://docs.unity3d.com/Manual/upm-scoped.html):
17+
In order to use this service you simply need to add a UPM [scoped registry](https://docs.unity3d.com/Manual/upm-scoped.html).
18+
19+
You can do this in several ways:
20+
21+
#### Via manifest.json
22+
23+
Manually edit your project's `Packages/manifest.json` file to look like the following:
1824

1925
```json
2026
{
2127
"scopedRegistries": [
28+
// Other registries...
2229
{
2330
"name": "Unity NuGet",
2431
"url": "https://unitynuget-registry.openupm.com",
@@ -28,14 +35,16 @@ In order to use this service you simply need to edit the `Packages/manifest.json
2835
}
2936
],
3037
"dependencies": {
38+
// Other dependencies...
3139
"org.nuget.scriban": "2.1.0"
3240
}
3341
}
3442
```
3543

36-
### Add scope registry (Package Manager UI)
44+
#### Via Package Manager UI
3745

38-
Instructions: <https://docs.unity3d.com/Manual/class-PackageManager.html>
46+
Alternatively, follow Unity's [instructions](https://docs.unity3d.com/Manual/class-PackageManager.html)
47+
to add the scoped registry via the Package Manager UI, with the following values:
3948

4049
```yaml
4150
Name: Unity NuGet
@@ -57,14 +66,23 @@ For earlier Unity versions, uncheck `Project Settings > Player > Other Settings
5766
### Verify scoped registry installation
5867

5968
> [!WARNING]
60-
> WARNING: If you are encountering weird compilation errors with UnityNuGet and you have been using UnityNuGet already,
69+
> If you are encountering weird compilation errors with UnityNuGet and you have been using UnityNuGet already,
6170
> it could be that we have updated packages on the server, and in that case, you need to clear the cache containing
6271
> all Unity NPM packages downloaded from the registry.
6372
> On Windows, this cache by default is located at: `%LOCALAPPDATA%\Unity\cache\npm`
6473
>
65-
> Cache locations by OS: <https://docs.unity3d.com/Manual/upm-cache.html>
74+
> See the [cache locations by OS](https://docs.unity3d.com/Manual/upm-cache.html).
6675

67-
When opening the Package Manager Window, you should see a few packages coming from NuGet (with the postfix text `‎ (NuGet)`)
76+
> [!WARNING]
77+
> You may also experience timeouts when installing UnityNuGet packages, with a message like:
78+
> > [Package Manager Window] Error adding package: org.nuget.microsoft.extensions.logging.abstractions@6.0.0.
79+
> > connect ETIMEDOUT 143.244.220.150:443
80+
> > UnityEditor.EditorApplication:Internal_CallUpdateFunctions ()
81+
>
82+
> Verify that you are using the new OpenUPM-based URL and not the old Azure Websites URL.
83+
> You can also check [OpenUPM Status](https://openupm.github.io/upptime/history/other-unity-nu-get-registry) to see if OpenUPM itself is having an outage.
84+
85+
When opening the Package Manager Window, you should see a few packages coming from NuGet with the postfix text `‎ (NuGet)`, like in this screenshot:
6886

6987
![UnityEditorWithNuGet](img/unity_editor_with_nuget.jpg)
7088

@@ -84,7 +102,6 @@ You also need to **specify the lowest version of your package that has support f
84102
Beware that **all transitive dependencies of the package** must be **explicitly listed** in the registry as well.
85103

86104
> [!NOTE]
87-
>
88105
> - We reserve the right to decline a package to be available through this service.
89106
> - The server will be updated only when a new version tag is pushed on the main branch.
90107

@@ -164,7 +181,7 @@ Having a `.NETStandard2.0` for NuGet packages for Unity can ensure that the expe
164181

165182
As of Unity 2021.x it also supports `.NETStandard2.1` so packages providing this target will be compatible with this version of Unity or newer.
166183

167-
> More information: <https://docs.unity3d.com/Manual/dotnet-profile-support.html>
184+
See Unity's documentation on [.NET profile support](https://docs.unity3d.com/Manual/dotnet-profile-support.html).
168185

169186
### **How this service is working?**
170187

0 commit comments

Comments
 (0)