Output JSON reports - part 1 #150

jt-traub · 2023-10-26T01:17:21Z

Because these changes are going to be somewhat far-reaching, I am going
to do these in smaller chunks. This chunk will contain

a new game config which defaults to not outputting json reports.
the inclusion of the nlohmann/json.hpp single-file json parser/manipulation library.
Output the basic faction info (meaning the fields on the faction itself, but NOT deeper structures like regions/objects/units)
An example of some small nested structures (skill shows/faction stats) to give examples of how this stuff will work.
A renaming of 2 rules helper functions from link/link_ref to url/anchor in order to avoid a conflict with the link() function from unistd.h which gets pulled in via the nlohmann/json.hpp standard library includes, and which caused the rules to break. This is JUST a renaming and no functionality change, so you can ignore all the changes in genrules.cpp as part of this.
Removing some duplicated skill data which was being output if you were shown a skill description which allowed you create an object which in turn allowed you to use a skill (create staff of healing shows the staff of healing, which then adds a skill show for magic healing). This wouldn't affect a player since a faction tracks whether or not a skill has been shown permanently and never shows it again, but when generating the turn 1 report for the gamemaster, if those items were enabled, 4 skills would end up shown twice. This also accounts for the change to the snapshot turn_0 report.1 file. Those changes are expected.

GAMEMASTER.md

jt-traub · 2023-10-26T01:18:49Z

aregion.cpp

+	// ie "Alioth Plains (1, 2) in Alioth contains Alioth City [City]."
+	// This will get broken down and become more json-y when I flesh this code out.
+	j["name"] = Print(pRegions).const_str();
+	return;


This is here solely so that the output shows that it is iterating the regions.. This is just a temp leaf.

jt-traub · 2023-10-26T01:20:50Z

faction.cpp

+	"won game"
+	"game over",
+};
+const string *QuitStrs = qs;


Needed these so I could output a textual string for the various quit states in the faction json.

jt-traub · 2023-10-26T01:21:48Z

faction.cpp

+			if (citems[pl][i] > citems[myfaction][i]) place++;
+			if (max < citems[pl][i]) max = citems[pl][i];
+			total += citems[pl][i];
+		}


Since you had already iterated all items for all units for all factions while building the citems array, there was no need to do so again here, so I just rewrote this to use the data you'd already collected :p

Also, it now returns it as a vector so I can output it in textual and json formats as needed.

jt-traub · 2023-10-26T01:24:16Z

faction.cpp

+	battles.DeleteAll();
+}
+
+void Faction::write_json_gm_report(json& j, Game *game) {


the gm reports were taking up a lot of space and making the report function hard to read, so I pulled all the gm stuff out into it's own pair of functions. I also just collect all the data up front and output it. This made the code cleaner imho.

jt-traub · 2023-10-26T01:27:59Z

faction.cpp

@@ -559,34 +790,27 @@ void Faction::WriteReport(ostream& f, Game *pGame, int ** citems)
 		f << '\n';
 	}

-	if (shows.Num()) {
+	if (!shows.empty()) {


I converted shows/objectshows/itemsshows into std::vector<> rather than Alists.. Slowly but surely, AList and AString will die too!

faction.cpp

Because these changes are going to be somewhat far-reaching, I am going to do these in smaller chunks. This chunk will contain - a new game config which defaults to not outputting json reports. - the inclusion of the nlohmann/json.hpp single-file json parser/manipulation library. - Output the basic faction info (meaning the fields on the faction itself, but NOT deeper structures like regions/objects/units) - An example of some small nested structures (skill shows/faction stats) to give examples of how this stuff will work. - A renaming of 2 rules helper functions from link/link_ref to url/achor in order to avoid a conflict with the link() function from unistd.h which gets pulled in via the nlohmann/json.hpp standard library includes, and which caused the rules to break. This is JUST a renaming and no functionality change, so you can ignore all the changes in genrules.cpp as part of this. - Removing some duplicated skill data which was being output if you were shown a skill description which allowed you create an object which in turn allowed you to use a skill (create staff of healing shows the staff of healing, which then adds a skill show for magic healing). This wouldn't affect a player since a faction tracks whether or not a skill has been shown permanently and never shows it again, but when generating the turn 1 report for the gamemaster, if those items were enabled, 4 skills would end up shown twice. This also accounts for the change to the snapshot turn_0 report.1 file. Those changes are expected.

fracas/rules.cpp

game.cpp

jt-traub · 2023-10-26T01:42:14Z

game.h

+	// Rather than making all of the functions & variables public, we can allow this special class to access them.
+	// This class won't be defined except in the unit test code, though it could be used in other places if there
+	// were a good reason to do so.
+	friend class UnitTestHelper;


this was the hack that I mentioned which allows me to do deeper unit testing where things need to get at internals of game but couldn't. I honestly am a big believer in 'only make public the things that should be public', so will probably over time be privatizing things in other classes/structs that are only used internally, and will likely grant other UnitTestHelper friend status to those other classes if needed.

genrules.cpp

jt-traub · 2023-10-26T01:45:06Z

skills.cpp

@@ -221,12 +221,6 @@ int StudyRateAdjustment(int days, int exp)
 	return rate;
 }

-ShowSkill::ShowSkill(int s, int l)


I made this into a struct with static initialization because it was a lot clearer.

jt-traub · 2023-10-26T01:49:18Z

snapshot-tests/neworigins_turns/turn_0/report.1

These 4 skills with just a couple ranks were caused by the enabled skills and objects such as create staff of healing, and the staff of healing. When you learned create staff of healing, it would also add the staff of healing item if your faction hadn't already discovered it, and adding that would add the magical healing skill if your faction hadn't discovered it.

Due to the way that gm reports work (where it just produces the skill show without 'discovering' that skill or item for the faction), these ended up duplicated. I could have changed the GM report to discover those items, but discovered items are stored in the game.out file for each faction and thus would have changed every snapshot turns game.out file rather than just changing the turn 0 report.1 file. Since this only affected GM reports for the first turn this seemed reasonable.

jt-traub · 2023-10-26T01:51:14Z

snapshot-tests/update-all-game-snapshots.sh

A couple of utility shell scripts to allow updating the snapshots of the games & rules if something changes that you expect to change (such as us changing output format or something or fixing a typo). Those would initially fail the test and then you can update all snapshots if the change was intended.

jt-traub · 2023-10-26T01:52:43Z

unittest/extra.cpp

@@ -36,8 +36,31 @@
 #include "gamedata.h"

 /// Run the initial setup for a faction
-/// which for a unit test is to do nothing
-int Game::SetupFaction( Faction *pFac ) { return 1; }
+/// For unit tests, factions get 1 leader with combat 3.


In order to unit test json reports, it still needs a valid game object correctly set up, so I construct a unit test world which has exactly 4 hexes and 1 city. The test will also have guards and wandering monsters, so those 2 factions are taken up as well.

jt-traub · 2023-10-26T01:53:59Z

unittest/map.cpp

@@ -70,6 +78,7 @@ void ARegionList::MakeRegions(int level, int xSize, int ySize)

 				Add(reg);
 				arr->SetRegion(x, y, reg);
+				Adot();


Just to make it easy to see how many regions got created since there are only 4 and it made testing the cout capturing have some data.

jt-traub · 2023-10-26T01:54:33Z

unittest/rules.cpp

@@ -168,7 +168,7 @@ static GameDefs g = {
 	0,	// UNDERWORLD_LEVELS
 	0,	// UNDERDEEP_LEVELS
 	0,	// ABYSS_LEVEL
-	100,	// TOWN_PROBABILITY
+	0,	// TOWN_PROBABILITY


I don't want it to spawn anything other than the 1 city I created.

jt-traub · 2023-10-26T01:58:55Z

external/nlohmann/json.hpp

This file is the single-include json handling library. Like the unit test framework (ut), it requires no external libraries or links so it will just work.

aregion.h

valdisz · 2023-10-26T06:44:01Z

Niels Lohmann's JSON library is finally here. It is an excellent addition to the codebase. This will allow many future changes.

I.e. game database files can be changed to the JSON format. It would make them less fragile and readable from the outside for different GM needs.

faction.h

jt-traub · 2023-10-26T16:14:33Z

Niels Lohmann's JSON library is finally here. It is an excellent addition to the codebase. This will allow many future changes.

I.e. game database files can be changed to the JSON format. It would make them less fragile and readable from the outside for different GM needs.

That is almost certainly in my plans for the future :)