Skip to content

Commit

Permalink
Refactored README, updated unity section to be out of beta
Browse files Browse the repository at this point in the history
  • Loading branch information
sacOO7 committed Feb 16, 2024
1 parent 7d9ad2c commit e3967c2
Showing 1 changed file with 1 addition and 15 deletions.
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,7 @@ The [Push Notifications Readme](PushNotifications.md) describes:
* How to send Ably messages that include a notification

## Unity

- Unity support is currently in beta.
- Supports both [Mono](https://docs.unity3d.com/Manual/Mono.html) and [IL2CPP](https://docs.unity3d.com/Manual/IL2CPP.html) builds.

**Downloading Unity Package**
- Please download the latest Unity package from the [GitHub releases page](https://github.com/ably/ably-dotnet/releases/latest). All releases from 1.2.4 has `.unitypackage` included.
- Please take a look at [importing unity package](./unity/README.md#importing-unity-package) doc for initial config. and usage.

**Supported Platforms**
- Ably Unity SDK supports **Windows, MacOS, Linux, Android and iOS**.
- It doesn't support **WebGL** due to incompatibility with WebSockets. Read the [Direct Socket Access](https://docs.unity3d.com/2019.3/Documentation/Manual/webgl-networking.html) section under WebGL Networking.
- To support **WebGL**, you should refer to [interation with browser javascript from WebGL](https://docs.unity3d.com/Manual/webgl-interactingwithbrowserscripting.html). You can import [ably-js](https://github.com/ably/ably-js) as a browser javascript and call it from WebGL. For more information, refer to the project [Ably Tower Defence](https://github.com/ably-labs/ably-tower-defense/tree/js-branch/).


**Note** - Please take a look at [Unity README](./unity/README.md) and [Ably Unity Blog](https://ably.com/blog/multiplayer-game-in-unity-with-ably) for more information.
Please take a look at [Unity README](./unity/README.md) and [Ably Unity Blog](https://ably.com/blog/multiplayer-game-in-unity-with-ably) for `ably-unity` sdk usage in your application.

## Known Limitations
* Browser push notifications in [Blazor](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor) are not supported.
Expand Down

0 comments on commit e3967c2

Please sign in to comment.