Skip to content

Commit

Permalink
fix readme 7.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jgoralcz committed May 15, 2024
1 parent 9b52b3e commit 5471573
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 82 deletions.
86 changes: 7 additions & 79 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@

An API for Akinator based in NodeJS.

## Requirements
| Requirement | Version |
| ---|---|
| Node | ^8.2.1 |
| NPM | ^5.3.0 |


## Installation

Expand All @@ -20,22 +14,14 @@ An API for Akinator based in NodeJS.
```js
[
'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',
Expand Down Expand Up @@ -110,7 +96,7 @@ run().catch(console.error);
```

### 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
#### Akinator will automatically guess when calling the answer() method

```js
const { Aki } = require('aki-api');
Expand All @@ -119,25 +105,18 @@ const run = async () => {
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);
}
const guessOrResponse = await aki.answer(); // check if it is a guess by akinator or another question

// if you do not like the answer...
await aki.continue();
}

run().catch(console.error);
```

### 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 enabled 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".
#### Simply pass in true or false for the childMode parameter
The child mode prevents showing explicit questions.

```js
const { Aki } = require('aki-api');
Expand All @@ -146,62 +125,11 @@ const run = async () => {
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);
}
}

run().catch(console.error);
```

### Output from above console.log

```json
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
```js
const { Aki } = require('aki-api');
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"author": "Joshua Goralczyk",
"version": "7.0.0",
"version": "7.0.1",
"main": "./dist/src/index.js",
"types": "typings/src/index.d.ts",
"license": "MIT",
Expand Down

0 comments on commit 5471573

Please sign in to comment.