nator-aki/README.md

An Simple API for Akinator

# Akinator API

## Install

```bash
npm install @aqul/akinator-api
```

## Usage

### Simple Usage
```js
const { Akinator, AkinatorAnswer } = require("@aqul/akinator-api")

const run = async () => {
  const region = "en"
  const api = new Akinator({ region, childMode: false })
  await api.start()
  console.log(`Question: ${api.question}, progress: ${api.progress}`)

    // To answer
  await api.answer(AkinatorAnswer.Yes) // or you can use 0-4
  console.log(`Question: ${api.question}, progress: ${api.progress}`)

  // To check is win or not
  while (!api.isWin) {
    await api.answer(Math.floor(Math.random() * 5)) // random 0-5
    console.log(`Question: ${api.question}, progress: ${api.progress}`)

    // To back last question
    if (Math.floor(Math.random() * 10) + 1 < 4) {
      await api.cancelAnswer()
      console.log(`Question: ${api.question}, progress: ${api.progress}`)
    }
  }

  // if is win
  if (api.isWin) {
    console.log(api.sugestion_name)
    console.log(api.sugestion_desc)
    console.log(api.sugestion_photo)
  }
}

run()
```

### To check region
```js
const { regions } = require("@aqul/akinator-api")
console.log(regions)
```

### Use proxy
```js
const { Akinator } = require("@aqul/akinator-api")
const tunnel = require("tunnel")

const httpsAgent = tunnel.httpsOverHttp({
  proxy: {
    host: "xxx.xxx.xxx",
    port: 8080,
    proxyAuth: "username:password"
  }
})

const region = "en"
const api = new Akinator({ region, childMode: false, config: {
  httpsAgent
}})
```