3 replies

Is this API intuitive ?

🗣️discussion

I've been working on improving the API used to describe the cards of a small game I'm making and I want opinions on it, do you think it's intuitive to use as is ? do you see things that would need to be improved ?

I'm not looking for feature ideas here, just a vibe check on the API itself (you can send suggestions for features there https://discord.com/channels/436251713830125568/1434558771044290790 instead)

here's how the API looks like when used at the moment : https://github.com/Ragnar-Oock/colon/blob/63d72db18946efd833ebbfd6845bbb4f25e1fbd4/src/cards.data.ts

the card object itself is documented in

helpers/card.helper.ts

helpers/card.helper.ts

the different helpers used to abstract the logic are :
- how many points will you get when placing a card :

src/helpers/score-multiplier.helper.ts

src/helpers/score-multiplier.helper.ts

- filter what other cards can impact the score :

src/helpers/neighborhood-predicate.helper.ts

src/helpers/neighborhood-predicate.helper.ts

- more functions to filter the cards that have an impact on score :

src/helpers/score-predicate.ts

src/helpers/score-predicate.ts

- and the functions that do the searching :

src/helpers/score.helper.ts

src/helpers/score.helper.ts

(the file names themselves need work but I want to iron out the functions first)

GitHub

A crude recreation of the Colon Catan card game in VueJS, totally a WIP - Ragnar-Oock/colon