search

zengm-games / zengm

Basketball GM (and other ZenGM games) are single-player sports management simulation games, made entirely in client-side JavaScript.
https://zengm.com
Other
360 stars 132 forks source link

Descriptions for important object keys #179

Open garyking opened 8 years ago

garyking commented 8 years ago

Can we maybe open up a wiki on this GitHub repo to store information on important variables?

Like, explanations on keys for the global object and team objects for starters.

For instance, "region refers to the area where the team is located, usually a city". "season refers to the current league season, represented as a year."

I'm guessing that a lot of these are explained in the source comments throughout, no doubt, but definitely would be easier to have it in wiki form.

What caused me to suggest this is when I just came across some keys that I have absolutely no idea what they do; digging through the source code will definitely find me the answer, but that'll be annoying after a while. @dumbmatter in particular probably has all this knowledge locked up in his head already, so he just has to write it down and it'll be a lot easier for us too.

The ones I just came across are team's tid (team ID), cid (?), did (?).

dumbmatter commented 8 years ago

Yeah a lot of this is a symptom of a codebase that's 99% written by one person, some things I just assume are known without even realizing that they aren't.

Object keys for the data in the game should be explained on https://basketball-gm.com/manual/customization/ although they might not all be there. Basically, things that would interest roster makers should go there, which is mostly what you're asking. But I don't have a great way to accept contributions to that now, since it's a WordPress page.

If there's other stuff, that could go here.

The ones I just came across are team's tid (team ID), cid (?), did (?).

cid = conference ID

did = division ID

which is explained at https://basketball-gm.com/manual/customization/teams/