https://github.com/gizmo-ds/UdonOTPLib

VRChat Udon OTP Library. contains a simple time-based one-time password example.
https://github.com/gizmo-ds/UdonOTPLib

totp udonsharp vrchat

Last synced: 2 months ago
JSON representation

VRChat Udon OTP Library. contains a simple time-based one-time password example.

• Host: GitHub
• URL: https://github.com/gizmo-ds/UdonOTPLib
• Owner: gizmo-ds
• License: mit
• Created: 2022-10-01T20:12:18.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-28T00:48:21.000Z (8 months ago)
• Last Synced: 2024-10-03T12:44:28.331Z (3 months ago)
• Topics: totp, udonsharp, vrchat
• Language: C#
• Homepage:
• Size: 81.1 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# UdonOTPLib

VRChat Udon OTP Library, HOTP([RFC 4226](https://tools.ietf.org/html/rfc4226)) & TOTP([RFC 6238](https://tools.ietf.org/html/rfc6238)).

> [!Caution]  

> This project is a personal learning exercise and serves as a demonstration of my learning outcomes. It is not intended for production environments or serious business applications. Use the code in this project at your own risk.

[Demo world](https://vrchat.com/home/launch?worldId=wrld_1590a2c1-7f17-40b7-a71c-b90b542a204c)

👇 Example video

[![thumbnail](https://i.imgur.com/pPMESvY.jpg)](https://youtu.be/KfkS4VoFgxc)

## Requirements

- Unity 2022.3.6f1

- VRChat SDK - Worlds (Tested version: 3.5.2)

## How to use

> Contains a simple example that you can use however you want.

1. Make sure you have imported the latest `VRChat SDK - Worlds`.

2. Download the latest [release](https://github.com/gizmo-ds/UdonOTPLib/releases/latest) and import it into your project.

3. Open the `_Gizmo/UdonOTPLib/Example/TOTP_Example.unity` scene.

4. You may need to import `TextMeshPro`.

5. Edit the `Secret` variable in the `TOTP_Example` gameobject. (You can use [totp-wasm.vercel.app](https://totp-wasm.vercel.app?secret=2LESRALCTRW3B3J4WYSXFQYE5ZR6V5R2) to generate `Secret`)

6. enjoy 🤓

### Parameter

| Name   | Type   | Description                  |

| ------ | ------ | ---------------------------- |

| secret | string | Secret key encoded in base32 |

| digits | int    | Code digits                  |

| period | int    | Time period (seconds)        |

| t      | double | Timestamp                    |

### Code example

```cs

string secret = "2LESRALCTRW3B3J4WYSXFQYE5ZR6V5R2";

int digits = 6;

int period = 30;

// Get the code

string code = otp.TOTP(secret, otp.Timestamp(), digits, period);

Debug.Log($"Code: {code}");

// Countdown

int s = otp.Countdown(period);

Debug.Log($"Countdown: {s}sec");

```

## Related

- [totp-wasm](https://github.com/gizmo-ds/totp-wasm)

- [totp-wasm-zig](https://github.com/gizmo-ds/totp-wasm-zig)

## License

Code is distributed under [MIT license](./LICENSE), feel free to use it in your proprietary projects as well.