Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rixment/awu-plugin

Android Wrapper for Unity
https://github.com/rixment/awu-plugin

android android-library unity unity-android unity-plugin

Last synced: about 1 month ago
JSON representation

Android Wrapper for Unity

Host: GitHub
URL: https://github.com/rixment/awu-plugin
Owner: rixment
License: mit
Created: 2020-03-17T07:44:09.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2021-01-20T13:45:30.000Z (almost 4 years ago)
Last Synced: 2024-09-30T18:02:22.736Z (about 1 month ago)
Topics: android, android-library, unity, unity-android, unity-plugin
Language: Java
Homepage:
Size: 151 KB
Stars: 12
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Android Wrapper for Unity (awu)

This is an Android's _library_ that is designed to be used as a plugin within Unity's project. It is created using Android Studio 3.6 and should consist of all projects files required by the IDE if one desires to tweak its functionality to his or hers needs.

The main purpose of this _library_ is to allow the user to retreive platform related information within Unity's project and currently includes:

- retreiving information regarding the state of the network via `isNetworkAvailable`
- determining established connection type via `IsConnectedViaCellular` and `IsConnectedViaWifi`
- determining if a device on which the app is running is of Tv-type via `isAndroidTv`
- text based message sharing with the use of Android's Intent mechanism via `shareText`

## How to integrate

1. Clone _awu_ repository and build the _library_ using Android Studio yourself or download the latest _.aar library_ release from [here](awu/build/outputs/aar/awu-release.aar)

2. Copy the _.aar library_ file into your Unity's project _Assets/Plugins/Android_ directory

3. _(Optional)_ In Unity select the _.aar library_ file from Project window and mark the option __Load on startup__ from the Inspector

4. Copy Unity's C# implementation available from [here](UnityScript/Awu.cs) into your _Assets/Scripts_

## Usage

Upon finishing the integration process described above you should be able to take advantage of _library's_ functionality.

In your C# Unity's code you can use it in the following way:

```csharp
bool isConnected = Awu.IsNetworkAvailable; // Let's check if we're connected to the internet

bool isTv = Awu.IsAndroidTv; // Let's check if the game is running on Android TV enabled device

bool isCellular = Awu.IsConnectedViaCellular; // Is mobile data connection established

bool isWifi = Awu.IsConnectedViaWifi; // Is wifi connection established

// Let's share our game with a friend via text message
Awu.ShareText("Share via", "My Awesome Game", new System.Uri("http://my.awesomegame.com"));
```

## Proguard

Projects utilising proguard obfuscation process should keep `-keep class rixment.awu.** { *; }` within its _proguard_ definition file.