Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/game-ci/unity-verify-code

An email parser to get 6 digit verification code
https://github.com/game-ci/unity-verify-code

tfa unity verfication verify

Last synced: about 2 months ago
JSON representation

An email parser to get 6 digit verification code

Awesome Lists containing this project

README

        

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![Release](https://img.shields.io/github/tag/jcs090218/unity-verify-code.svg?label=release&logo=github)](https://github.com/jcs090218/unity-verify-code/releases/latest)
[![npm](https://img.shields.io/npm/v/unity-verify-code?logo=npm&color=green)](https://www.npmjs.com/package/unity-verify-code)
[![npm-dt](https://img.shields.io/npm/dt/unity-verify-code.svg)](https://npmcharts.com/compare/unity-verify-code?minimal=true)
[![npm-dm](https://img.shields.io/npm/dm/unity-verify-code.svg)](https://npmcharts.com/compare/unity-verify-code?minimal=true)

# unity-verify-code

[![dependencies Status](https://status.david-dm.org/gh/jcs090218/unity-verify-code.svg)](https://david-dm.org/jcs090218/unity-verify-code)

An email parser to get 6 digit verification code.

This tool is design to use with [unity-license-activate](https://github.com/jcs090218/unity-license-activate)
so you can feed verification code to get pass Unity's TFA.



## 💾 Prerequisite

This application uses IMAP to parse your verification email from Unity, so make
sure your email's IMAP service is enabled!

* `Gmail`, see [How Can i receive incoming mails(gmail) to my application server using imap (nodejs)](https://stackoverflow.com/questions/62404008/how-can-i-receive-incoming-mailsgmail-to-my-application-server-using-imap-nod)

*P.S. All email services should have the similar steps!*

### 📬 Supported mail services

| Name | Done | Value |
|---------|------|-------------------------|
| Gmail | ✔ | `imap.gmail.com` |
| Hotmail | ✔ | `imap-mail.outlook.com` |
| Outlook | ✔ | `imap-mail.outlook.com` |
| Yahoo | ✔ | `imap.mail.yahoo.com` |
| Foxmail | ✔ | `imap.qq.com` |
| QQ | ✔ | `imap.qq.com` |

## 🔨 How to use?

You can use these tools with any CI/CD system as long as you have the [Node](https://nodejs.org/en/)
environment set up! Here is an example of GitHub Actions.

```yml
jobs:
acquire_ulf:
name: Acquire .ulf file 🔑
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
steps:
- name: Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}

- name: Install node package, `unity-license-activate`
run: npm install --global unity-license-activate

# You would only have to install it!
- name: Install node package, `unity-verify-code`
run: npm install --global unity-verify-code

- name: Activate the license
run: unity-license-activate "${{ secrets.UNITY_EMAIL }}" "${{ secrets.UNITY_PASSWORD }}" "${{ needs.request_alf.outputs.alf }}"
```

See the full example [here](https://github.com/jcs090218/JCSUnity/blob/master/.github/workflows/license.yml).

## 📇 Command Line Arguments

```console
usage : unity-verify-code [--port] [--tls]
EMAIL [EMAIL ...] PASSWORD [PASSWORD ...] HOST [HOST ...]
SAVE_PATH [SAVE_PATH ...]

Unity License Activate : An email parser to get 6 digit verification code.

positional arguments:
EMAIL Username or Email you use to register for Unity account
PASSWORD Password to login Unity account
SAVE_PATH File path to save the 6 digit code.

optional arguments:
--port Port number of the IMAP server. Default: 143
--tls boolean - Perform implicit TLS connection? Default: false
```

## ⚜️ Licence

This repository is [MIT](./LICENSE) licensed.

This includes all contributions from the community.