Giter Club home page Giter Club logo

aki-api's Introduction

aki-api (Akinator)

CircleCI npm version License: MIT

An API for Akinator based in NodeJS.

IMPORTANT: Version 4 is a functional approach while Version 5 is an object-oriented approach. Please be aware of the differences!

This package contains all the features that you will need to interact with the Akinator API. Below you will find information on how to install the package and utilize the package's features. This package supports 15 different languages.

Requirements

Requirement Version
Node ^8.2.1
NPM ^5.3.0

Installation

npm i aki-api

Regions

 [
  'en',
  'en_objects',
  'en_animals',
  'ar',
  'cn',
  'de',
  'de_animals',
  'es',
  'es_animals',
  'fr',
  'fr_objects',
  'fr_animals',
  'il',
  'it',
  'it_animals',
  'jp',
  'jp_animals',
  'kr',
  'nl',
  'pl',
  'pt',
  'ru',
  'tr'
]

Usage

const { Aki } = require('aki-api');

const region = 'en';

const aki = new Aki(region);

await aki.start();

console.log('question:', aki.question);
console.log('answers: ', aki.answers);

Output from above console.log

question: Is your character real?
answers: [  
  "Yes",
  "No",
  "Don't know",
  "Probably",
  "Probably not"
]

Get regions that I support

  const { regions } = require('aki-api');
  
  console.log(regions);

Answer a Question (step)

const { Aki } = require('aki-api');

const region = 'en';
const aki = new Aki(region);

await aki.start();

const myAnswer = 0; // yes = 0

await aki.step(myAnswer);

console.log('question:', aki.question);
console.log('answers:', aki.answers);
console.log('progress:', aki.progress);

Win/Show the akinator's guess

To determine a win use the progress property. I like to do something like if(aki.progress >= 70) or check the current step against the max of 80

const { Aki } = require('aki-api');

const region = 'en';
const aki = new Aki(region);

await aki.start();

const myAnswer = 0; // yes = 0

await aki.step(myAnswer);

if (aki.progress >= 70 || aki.currentStep >= 78) {
  await aki.win();
  console.log('firstGuess:', aki.answers);
  console.log('guessCount:', aki.guessCount);
}

Enable child mode

Simply pass in true or false for the 2nd parameter in the constructor.

The child mode prevents showing explicit questions. However, the results (from aki.win()) will still contain characters that do contain NSFW (non-child mode content). To check if the images contain NSFW content, you need to check for a property called nsfw which will be true or false (this can be inaccurate to some degree) or filter by the property pseudo. The pseudo property is a string that marks NSFW content with an 'X' or other NSFW term to describe the character. When child mode is enbaled on the site and a NSFW character is guessed, Akinator says, "I know who you are thinking of, but I believe this is not for young people".

const { Aki } = require('aki-api');

const region = 'en';
const childMode = true;
const aki = new Aki(region, childMode);

await aki.start();

const myAnswer = 0; // yes = 0

await aki.step(myAnswer);

if (aki.progress >= 70 || aki.currentStep >= 78) {
  await aki.win();
  console.log('firstGuess:', aki.answers);
  console.log('guessCount:', aki.guessCount);
}

Output from above console.log

firstGuess: [
  {
    "id": "78924",
    "name": "YoRHa No.2 Type B \/ 2B",
    "id_base": "9241962",
    "proba": "0.953825",
    "description": "NieR: Automata",
    "valide_contrainte": "1",
    "ranking": "1678",
    "minibase_addable": "0",
    "relative_id": "-1",
    "pseudo": "TitansBane",
    "picture_path": "partenaire\/b\/9241962__1967810663.jpg",
    "flag_photo": "2",
    "absolute_picture_path": "http:\/\/photos.clarinea.fr\/BL_25_en\/600\/partenaire\/b\/9241962__1967810663.jpg"
  },
  {
    "id": "85376",
    "name": "2B",
    "id_base": "11509417",
    "proba": "0.0286481",
    "description": "NieR: Automata",
    "valide_contrainte": "1",
    "ranking": "25597",
    "minibase_addable": "0",
    "relative_id": "-1",
    "pseudo": "2BIsMyWaifu",
    "picture_path": "partenaire\/o\/11509417__321330868.jpg",
    "flag_photo": "2",
    "absolute_picture_path": "http:\/\/photos.clarinea.fr\/BL_25_en\/partenaire\/o\/11509417__321330868.jpg"
  }
]

guessCount: 2

Example Code for Back

const { Aki } = require('aki-api');

const region = 'en';
const aki = new Aki(region);

await aki.start();

const myAnswer = 1; // no = 1

await aki.step(myAnswer);
await aki.back();

console.log('question:', aki.question);
console.log('answers:', aki.answers);

aki-api's People

Contributors

arabov avatar dependabot[bot] avatar dragonfire535 avatar jgoralcz avatar pealan avatar theusaf avatar xenorio avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.