shipow / searchstone Goto Github PK

:black_joker: Hearthstone's cards search engine built with algolia instantsearch.

JavaScript 62.56% Haml 7.27% SCSS 30.17%

algolia hearthstone algolia-instantsearch card game

searchstone's Introduction

Searchstone.io

Searchstone.io is an open source search engine for the Hearthstone card playing video game. It relies on Algolia API for the search and instantsearch.js for the UI.

Read the project story on Medium: A painstakingly crafted search for Hearthstone

If you want to be involved in that project there are many ways to participate. You could obviously open issues or submit some PR on this github repo and we initiated the discussion on the Show & Tell section of Algolia's community forum. You can also find us participating to the Hearthsim community on Discord.

Features

Search as-you-type experience
Full-text search in name, description and attributes
Smart Highlighting
Multi-language support
Typo tolerance
List and grid views
Refinement on every attributes (Set, Race, Type, Mana, Class, Mechanics, Attack, Health)
Golden animations cards
Responsive design + Retina support
Top decks
Search by Artist
Speed ⚡
PWA (in progress)

Development

Run the website

$> yarn install
$> yarn dev

Build for production (deployed by Netlify)

$> yarn build

Extension Release Update

Config API keys

edit 'config.json', add your Algolia and Cloudinary credentials (App ID/ API key).

Extract pics

First, update your game to latest version.

The following commands will install dependencies in a virtual environment:

$> python3 -m venv myenv
$> source myenv/bin/activate
$> pip install --upgrade pip setuptools wheel
$> pip install unitypack decrunch
$> pip install lz4 hearthstone unitypack pillow

Now, download and run HearthSim's extract script:

$> git clone https://github.com/HearthSim/HearthstoneJSON.git
$> cd HearthstoneJSON
// adapt with your game directory
$> python ./generate_card_textures.py --outdir=textures/ /Applications/Hearthstone/Data/OSX/{rad_base,card,premiummaterials,shared}*.unity3d --skip-existing
$> deactivate

copy only the .jpg images from HearthstoneJSON/textures/512px/ to your searchstone/import/art/ folder
run script to upload files to Cloudinary
```
$> gulp cloudinary:art
```

Script update

look at potential changes on https://hearthstonejson.com/
edit import/import.js
update variables set (ie. "ICECROWN": "Frozen Throne"), setID (ie. "ICECROWN": 11), map (ie. "OVERLOAD": "Overload"), configure condition for set.format regarding the current year for standard.

Update records in Algolia Index

Select the latest version here https://api.hearthstonejson.com/v1/
Download card collectible in 'all' languages (ie. https://api.hearthstonejson.com/v1/20970/all/cards.collectible.json)
Put the file in import/in
Run import.js script:
```
$> node import
```
upload import/out/algolia-hearthstone.json to Algolia
```
$> gulp algolia:index
```

Algolia instantSearch.js configuration

edit src/js/algolia-instantsearch-conf.js
update set (ie: ICECROWN), setFull (ie. ICECROWN : "Frozen Throne")

UI

add set icons to the sketch file and export setIcons.svg
add set class definition to hits.scss and refinements.scss

Extra: Animated Golden Cards, Top Decks and Hearthpwn links

update card list from Hearthpwn $>node import-hearthpwn-cards.js
merge data by running again $> node import.js
update deck list from Hearthpwn $>node import-hearthpwn-decks.js

searchstone's People

Contributors

Stargazers

Watchers

searchstone's Issues

Remove highlighting css in details view

Use the production build of React

Warning: It looks like you're using a minified copy of the development build of React. When deploying React apps to production, make sure to use the production build which skips development warnings and is faster. See https://fb.me/react-minification for more details.

Class cards incorrect on live site

Currently the live site has all class cards categorized as neutral cards except for the multi-class cards (Kabal etc)

Use a better font

The current font seems to not be correctly loaded

Unable to close the language selector when clicking outside

The only way to close the language selector currently seems to either select a value, or click on the header. It would be better if any click outside of it closed it, like the default select behavior.

Description is too long

The description text is too long and does not fit in the allocated space.

Any plan to add the ONiK cards?

It's a cool search engine, so would have loved to be able to use it with the latest cards

Missing card type: bloodreaver Guldan and other DK heroes and other cards

Shifter zerus image is not the right one.

Only for the non-gold.

Flare is missing

The hunter card "Flare" doesn't seem to be in your database.

Flatten discover targets on discover mechanics cards.

Ironforge rifleman wrong graphic

Hi there, I noticed the card "ironforge rifleman" has the wrong image as "stormwind champion".
Can you fix it?

Thank you and sorry for my bad english.

add keyword filtering or advanced facet filters

ex. attack:1-3 to show minions in that range

Additional underscore in description

This card has an additional undescore after Cri de guerre

Make the language selector apply to the whole UI

Currently, switching to FR or IT only change the name and description of the cards. Maybe we should update the whole UI?

Russian description rarely fit

In russian, the description text rarely fit the available space. Maybe decrease the font-size for Russian?

Ok, that's even worse in Thai:

Add facets on artist name, maybe in another view

Wrong image for card

This is not the correct image for Maexnna

searchbox strange style

webkit (safari+chrome) - macOS yosemite

Wrapper of the searchbox is too large on firefox

https://www.dropbox.com/s/2s7ass6t3c0xrgl/Screenshot%202016-05-16%2014.37.31.png?dl=0

Race is not translated

The race of minions at the bottom of the cards is not translated to the selected language

French internationalization issue

Some cards have singular/plural i18n notes still embedded in their display:

Wee Spellstopper data is wrong

The artwork for this card is completly wrong.

Encode artist links

http://searchstone.io/?fR%5Bartist%5D%5B0%5D=Zoltan%20&%20Gabor

Why are the card images stored as base64 encoded data?

Is this an optimization for indexed searching for Algolia? Stack overflow says base64 encoded images use up more memory..

Missing card type: quest

I think that the quests are a new type of cards introduced with Ungoro, that would be cool to add them in the search for card types.

Add golden card animation

Align "no results" with class header

The "No result" heading is not aligned with the class header above

Enhancement: Adding the flavor text on mouseover

Might be interesting to add the flavor text (the funny card description in the collection) when hovering the cards?

Add a cool hover effect for the cards view

Let the user add AND or OR between the filters

For example, you may want to show the weapons OR the pirates.
Right now you can select (weapons OR minions) AND pirates which returns only the pirates.

It's excessive and would probably result to a cumbersome UI but i wanted to throw it as an idea.