/agent-unity

The project brings the IC ecosystem to Unity, allowing Unity developers to call the functions of canisters on IC

Primary LanguageRustMIT LicenseMIT

Agent of Internet Computer for Unity

The Intro

The project brings the IC ecosystem to Unity, allowing Unity developers to call the functions of canisters on IC, providing useful utilities to make authentication and authorization easy.

The Status

The project is in an early stage, feature-less, documentation-sparse, and API will be changed frequently.

NOTE: Beta version is available, Only for experiment!

Milestones

Milestone 01: 【Draft】Call IC methods on Unity3D

  • ✨ Support HostKeyStore, a simple encrypted account module;
  • ✨ Support login/logout by HostKeyStore;
  • ✨ Call query methods on ic mainnet;
  • ✨ Call update methods on ic mainnet;
  • ✨ Support target: x86_64-win;
  • ✨ Support target: x86_64-nix;
  • ✨ Support target: aarch64-osx;
  • ✨ Support target: x86_64-osx;

Milestone 02: 【Basic】Core features/libraries mapping

  • ✨ Mapping candid from rs to cs;
  • ✨ Mapping ic-types from rs to cs;
  • ✨ Mapping ic-agent from rs to cs;
  • ✨ Mapping ic-utils from rs to cs;

How to build

# init python env
sh ./init.sh

# make the unity package, will produce a unity package with four targets:
# x86_64-win, x86_64-nix, x86_64-osx, aarch64-win
./publish --release --input=all

Look the detail.

How to install

  • Install of the official UPM package

    TODO

  • Installation via Git in UPM

    upm-via-git

    https://github.com/ShikuLabs/agent-unity.git#upm

  • Installation via

    upm-via-git

    NOTE: The installation file will be put on Release page.

How to use

Please check the samples of ICAgent!

Window -> Package Manager -> Find IC Agent Package -> Choice the sample you want to check

upm-samples