Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlexMeesters/unity-appwrite-plugin
Unofficial & non affiliated Appwrite plugin for Unity
https://github.com/AlexMeesters/unity-appwrite-plugin
Last synced: 3 months ago
JSON representation
Unofficial & non affiliated Appwrite plugin for Unity
- Host: GitHub
- URL: https://github.com/AlexMeesters/unity-appwrite-plugin
- Owner: AlexMeesters
- License: mit
- Created: 2022-11-16T22:46:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-28T10:12:26.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T07:24:19.760Z (6 months ago)
- Language: C#
- Homepage:
- Size: 1.33 MB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-appwrite - Source Code
README
## Unofficial & non affiliated [Appwrite](https://github.com/appwrite/appwrite) plugin for Unity
**Still in early development. Not yet battle tested.**
So far the Unity plugin for Appwrite supports some of the account features. \
It stores the session cookie automatically for you, meaning you keep your session even upon restart.
Current features
- Login
- Get user information
- Get JWT token
- Register user
- Send verification mail
- Store cookies on disk automatically
- Simple AES Encryption for stored data
Dependencies
- [UniTask](https://github.com/Cysharp/UniTask) for lower allocation counts & WebGL support
- JSON . Net for JSON support
## Included menu
## Getting started
### Install UniTask
This package makes use of UniTask, a package that uses a lot less allocations for C# Tasks.
It also makes deploying to WebGL easier as regular Tasks cause errors with WebGL.
To install UniTask go here: https://github.com/Cysharp/UniTask#upm-package
### Install JSON. Net
JSON. Net is used to generate JSON for the requests, as well as deserialize responses from Appwrite.
Reason I did not choose for the JsonUtility was because the underlying queries could still change,
and this allowed me to just fetch specific parameters.
### To install JSON. Net
Add the following to the manifest.json in /YourProjectFolder/Packages/manifest.json
"com.unity.nuget.newtonsoft-json": "3.0.2",
### Install TextMeshPro
The example menu makes use of TextMeshPro.
Go to the package manager and locate TextMeshPro and install it.
## Easy install using the Unity Package Manager
```
https://github.com/AlexMeesters/unity-appwrite-plugin.git?path=Assets/Plugins/Lowscope/Appwrite
```
##
Once the project is installed and no errors occur. Run the game, and a file called "Appwrite Config" should appear in the Resources folder.
Configure it to connect to your Appwrite server.
### Code Example
```csharp
using Lowscope.AppwritePlugin;
using Lowscope.AppwritePlugin.Accounts.Enums;
using Lowscope.AppwritePlugin.Accounts.Model;
using UnityEngine;
public class BasicUsage : MonoBehaviour
{
public async void Start()
{
// Get user info from disk -> verify with server if session is valid.
// -> Not valid, then nullified.
User user = await Appwrite.Account.GetUser();
if (user != null)
{
string id = user.Id;
string name = user.Name;
string email = user.Email;
bool verifiedEmail = user.EmailVerified;
}
}
public async void Login(string email, string password)
{
var (user, response) = await Appwrite.Account.Login(email, password);
if (response == ELoginResponse.Success)
{
// Use user here.
}
else
{
Debug.Log($"Error occured: {response}");
}
}
public async void Register(string id, string name, string email, string password)
{
var (user, response) = await Appwrite.Account.Register(id, name, email, password);
if (response == ERegisterResponse.Success)
{
// Use user here
// User can opt to send verify email directly after
}
else
{
Debug.Log($"Error occured: {response}");
}
}
public async void VerifyEmail()
{
// Sends request from current user session
var response = await Appwrite.Account.RequestVerificationMail();
if (response == EEmailVerifyResponse.Sent)
{
// Email has been sent!
}
else
{
Debug.Log($"Error occured: {response}");
}
}
public async void GetJwt()
{
// Sends request from current user session
var jwt = await Appwrite.Account.ObtainJwt();
if (!string.IsNullOrEmpty(jwt))
{
// Use the JWT. Cached based on duration specified in configuration.
}
}
}
```