I'm working on a Antistasi-style scenario with ALiVE (players are guerillas), and we're going to be adding some systems on top of ALiVE for tracking player progress, etc.
The documentation available for people looking to extend, build on top of, or otherwise use ALiVE outside of the editor is kind of sparse. For example, the core data types aren't explained anywhere (what's the difference between an objective, a cluster, and a sector? What data does each contain?), and the headers on the code itself aren't very verbose either.
As an example, we're looking to add an "influence" system, where the mission keeps track of which side is dominant in each town (if the players are dominant in a majority of the towns on the map, they win). It took me a while to figure out that the best way to do this would be to access all the civillian clusters via `ALIVE_clustersCivSettlement`, narrow it down via a TAOR, and then use `fnc_getDominantFaction`. I was confused by whether or not I should be looking at objectives or sectors, but realized clusters were really what I wanted. Maybe this isn't even the best way!
The only thing currently available on the wiki for people like me is Script Snippets .
Where should this sort of documentation live? In the code itself, in function headers? Or can we get a new Wiki section that documents the internals of ALiVE?
