search

kbuzsaki / bingosync

Collaborative bingo boards for speedrun races
https://bingosync.com
88 stars 105 forks source link

FYI: I put some generator base documentation in the wiki #164

Open CAD97 opened 2 years ago

CAD97 commented 2 years ago

https://github.com/kbuzsaki/bingosync/wiki/Generator-Bases-Documentation

I was explaining how to use the generators (that I know how they work), so I thought, why not write it down such that there's a reference to point people at in the future.

The generator bases documentation status:

I'm not familiar enough with the other generators to be able to usefully extract the bingo list structure into documentation, so it'd be awesome if someone familiar with them could do so.

kbuzsaki commented 2 years ago

Thanks for doing this by the way :)

Warmyone commented 10 months ago

I was struggling to understand how the generators work and ended up reading through the code of most of them. I advanced the wiki page quite a bit. Maybe someone can check if I made some mistake. Also, it might be helpful to link that page in the about section so people can better find it and have it easier to understand how the generators work.

Furthermore, I think that the explanation of SRL v5 on the about page is misleading on what the generator actually does. As by that explanation, one might expect a minimization algorithm that ensures that the sum of the difficulties in each line is equal. Which is not the case. Also, it is a 1 to 1 matching from the groups and squares, as the use of other difficulties is not possible in v5 but only in v8.