Skip to content

Commit 5da1d9e

Browse files
committed
Readme update 2
1 parent dfe69d0 commit 5da1d9e

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

howlongtobeatpy/README.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,22 @@ It is inspired by [ckatzorke - howlongtobeat](https://github.com/ckatzorke/howlo
1212

1313
## Content
1414

15-
- [Usage](#usage)
16-
- [Installation](#installation)
17-
- [Installing the package downloading the last release](#installing-the-package-downloading-the-last-release)
18-
- [Installing the package from the source code](#installing-the-package-from-the-source-code)
19-
- [Usage in code](#usage-in-code)
20-
- [Start including it in your file](#start-including-it-in-your-file)
21-
- [Now call search()](#now-call-search)
22-
- [Alternative search (by ID)](#alternative-search-by-id)
23-
- [DLC search](#dlc-search)
24-
- [Results auto-filter](#results-auto-filter)
25-
- [Reading an entry](#reading-an-entry)
26-
- [Issues, Questions & Discussions](#issues-questions--discussions)
27-
- [Authors](#authors)
28-
- [License](#license)
15+
- [HowLongToBeat Python API](#howlongtobeat-python-api)
16+
- [Content](#content)
17+
- [Usage](#usage)
18+
- [Installation](#installation)
19+
- [Installing the package downloading the last release](#installing-the-package-downloading-the-last-release)
20+
- [Installing the package from the source code](#installing-the-package-from-the-source-code)
21+
- [Usage in code](#usage-in-code)
22+
- [Start including it in your file](#start-including-it-in-your-file)
23+
- [Now call search()](#now-call-search)
24+
- [Alternative search (by ID)](#alternative-search-by-id)
25+
- [DLC search](#dlc-search)
26+
- [Results auto-filters](#results-auto-filters)
27+
- [Reading an entry](#reading-an-entry)
28+
- [Issues, Questions \& Discussions](#issues-questions--discussions)
29+
- [Authors](#authors)
30+
- [License](#license)
2931

3032
## Usage
3133

@@ -114,7 +116,7 @@ SearchModifiers.HIDE_DLC
114116

115117
This optional parameter allow you to specify in the search if you want the default search (with DLCs), to HIDE DLCs and only show games, or to ISOLATE DLCs (show only DLCs).
116118

117-
### Results auto-filter
119+
### Results auto-filters
118120

119121
To ignore games with a very different name, the standard search automatically filter results with a game name that has a similarity with the given name > than `0.4`, not adding the others to the result list.
120122
If you want all the results, or you want to change this value, you can put a parameter in the constructor:
@@ -133,6 +135,14 @@ results = HowLongToBeat(0.0).search("Awesome Game", similarity_case_sensitive=Fa
133135

134136
**Remember** that, when searching by ID, the similarity value and the case-sensitive bool are **ignored**.
135137

138+
An auto-filter for game-types has been added, it is not active by default (False) but can be used as:
139+
140+
```python
141+
results = HowLongToBeat(input_auto_filter_times = True).search("The Witcher 3")
142+
```
143+
144+
That auto-filter "nullify" values based on the game-type, if it is a singleplayer game then the coop/multiplayer values are overridden to Null; on the other side if it is a Multiplayer game the singleplayer values such as "main story" could be overridden to Null if that game doesn't have a story. Use with caution, it is probably better if you decide what fits best for you.
145+
136146
### Reading an entry
137147

138148
An entry is made of few values, you can check them [in the Entry class file](https://github.com/ScrappyCocco/HowLongToBeat-PythonAPI/blob/master/howlongtobeatpy/howlongtobeatpy/HowLongToBeatEntry.py). It also include the full JSON of values (already converted to Python dict) received from HLTB.
@@ -145,7 +155,7 @@ If you need any new feature, or want to discuss the current implementation/featu
145155

146156
## Authors
147157

148-
* **ScrappyCocco** - Thank you for using my API
158+
- **ScrappyCocco** - Thank you for using my API
149159

150160
## License
151161

0 commit comments

Comments
 (0)