Game manual?

[borgeser]

Hi ashugeo and thank you for this game!

I had a hard time figuring out how to add a new tile. A short manual with the keyboard shortcuts would be very appreciated :)

I was also wondering: what is the status of this project? Is the game fully implemented or are some rules missing? Do you plan to work on it anymore?

I'm not an experienced web developer but I will definitely spend some time in order to understand your code and see if I can add some features.

Regards,

A French compatriote.

[hugosaintemarie]

Hello @borgeser 👋

This game is a little side-project of mine that I've started working on a couple years ago when a friend made me discover the board game. I hadn't worked on it for a while, but then recently with the lockdown I decided to continue working on it! I'm not an experienced web developer either but I learn new stuff with this kind of projects!

Currently as you'll see in dev branch, I'm working on dropping p5.js and using pure SVG instead to draw the board and other items. I haven't yet worked on UX features, user onboarding and such. Not all rules (scenarios) are implemented yet (for instance role swap is commented out currently). I am looking forward to adding them! Also I need to clean up a lot of mess, and improve some parts with new stuff I've learnt for the past couple years!

I haven't yet communicated around this project (but you found me 👀) because I think at this point it's a bit of a copyright infringement towards Sit Down! games. I still have to figure it out and maybe ask them for some kind of permission, I really don't wanna do this the wrong way. This is also the reason why I haven't made it "easy to understand" so far.

Here's a list of controls currently in use in the master branch version:

• click and drag to move heroes around
• press C to add a tile (esc to cancel)
• R and T rotate a "picked" tile before setting it down
• left click to set down a tile
• Z, Q, S, D will move the camera around (camera is kinda broken currently)
• E and A zoom in and out respectively (camera is kinda broken currently)
• a few other hacking shortcuts I've used for development

[borgeser]

Thank you for your answer.

May I know why you are planning removing p5.js?

I've browsed your project and here are some tips:

• I'd suggest using a design pattern like Model-View-Controller or other. Currently the code is mixed so it's difficult to work on the models without touching the UI or to change the UI without affecting the game logic. Changing the rendering engine from p5 to svg would be easier with this architecture.
• You have a lot of singletons (board, clock, heroes,...). It's not that bad but it's harder to work with. For instance, if you want to restart the game, I think you will need a reset() method for all these classes but...
• You need a game engine. The C of MVC. The main orchestrator. It would be easier to follow the flow of events and actions. For instance, the sockets.js file would communicate only with the game engine. With a game engine, you can do integrity check to avoid things happening at the bad time. When the game is done and you want to go to the next level, you just trash the current game instance and create a new one. It would simplify also the swap roles routine.

You won't need to delete a lot of code, just to move the code on appropriate files. Nevertheless your code is clear and easy to follow.

I'd be glad to help but I don't want to conflict with your refactoring. If you are interested by some of my suggestions or help in any way, you can contact me by email.

[hugosaintemarie]

Hello again @borgeser,

I'm removing p5.js to improve performance, and get rid of a lib. Also it will fix an issue with the minified version of p5.js which is actually not minified.

Thank you so much for your tips! This sounds complex to me but I'll make sure to get in touch when I think of improving the overall structure like you suggested. 🙏