https://github.com/fxnai/fxn3d

Run Python functions in Unity3D. Register at https://fxn.ai
https://github.com/fxnai/fxn3d

Last synced: about 2 months ago
JSON representation

Run Python functions in Unity3D. Register at https://fxn.ai

• Host: GitHub
• URL: https://github.com/fxnai/fxn3d
• Owner: fxnai
• License: apache-2.0
• Created: 2023-05-22T12:43:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-08T15:52:22.000Z (9 months ago)
• Last Synced: 2024-04-08T19:06:39.399Z (9 months ago)
• Language: C#
• Homepage: https://docs.fxn.ai
• Size: 119 MB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Function for Unity Engine

![function logo](https://raw.githubusercontent.com/fxnai/.github/main/logo_wide.png)

[![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fy5vwgXkz2f%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Function%20community)](https://discord.gg/fxn)

Run Python functions (a.k.a "predictors") locally in your Unity apps and games, with full GPU acceleration and zero dependencies.

> [!TIP]

> [Join our waitlist](https://fxn.ai/waitlist) to bring your custom Python functions and run them on-device across Android, iOS, macOS, Linux, web, and Windows.

## Installing Function

Add the following items to your Unity project's `Packages/manifest.json`:

```json

{

  "scopedRegistries": [

    {

      "name": "Function",

      "url": "https://registry.npmjs.com",

      "scopes": ["ai.fxn"]

    }

  ],

  "dependencies": {

    "ai.fxn.fxn3d": "0.0.30"

  }

}

```

## Retrieving your Access Key

Head over to [fxn.ai](https://fxn.ai) to create an account by logging in. Once you do, generate an access key:

![generate access key](https://raw.githubusercontent.com/fxnai/.github/main/access_key.gif)

Then add it to your Unity project in `Project Settings > Function`:

![add access key to Unity](settings.gif)

> [!CAUTION]

> If your Unity project is open-source, make sure to add `UserSettings/` to your `.gitignore` file to keep your Function access key private.

## Making a Prediction

First, create a Function client:

```csharp

using Function;

// Create a Function client

var fxn = FunctionUnity.Create();

```

Then make a prediction:

```csharp

// Make a prediction

var prediction = await fxn.Predictions.Create(

    tag: "@fxn/greeting",

    inputs: new () { ["name"] = "Roberta" }

);

// Log the result

Debug.Log(prediction.results[0]);

```

## Requirements

- Unity 2022.3+

## Supported Platforms

- Android API Level 24+

- iOS 14+

- macOS 12+ (Apple Silicon and Intel)

- Windows 10+ (64-bit only)

- WebGL:

  - Chrome 91+

  - Firefox 90+

  - Safari 16.4+

## Useful Links

- [Discover predictors to use in your apps](https://fxn.ai/explore).

- [Join our Discord community](https://discord.gg/fxn).

- [Check out our docs](https://docs.fxn.ai).

- Learn more about us [on our blog](https://blog.fxn.ai).

- Reach out to us at [[email protected]](mailto:[email protected]).

Thank you very much!