Added general compability for tableGenerator (SWTbahn-Game) #132

noriakisana · 2024-01-24T12:15:15Z

Changed the tableGenerator to automatically generate all configuration files which are needed for the driver-game, as soon a mappingFile is existing.

Signed-off-by: Jochen Mehlich <[email protected]>

…ion file Signed-off-by: Jochen Mehlich <[email protected]>

Signed-off-by: Jochen Mehlich <[email protected]>

eyip002 · 2024-01-24T15:31:41Z

Have you tested that the Game still works? I don't think the Game works anymore.
How does the Game know which platform it is connected to, so that it uses the correct flag mappings?

The generated destinations-swtbahn-full.json includes the blacklisted routes. You should restore the previous blacklist.txt file and rename it to blacklist-swtbahn-full.txt and update your Python script accordingly.

noriakisana · 2024-01-24T15:35:43Z

Currently the platforms have to been set manual. For an automatic solution the issue #131 have to be fixed.

Signed-off-by: Jochen Mehlich <[email protected]>

noriakisana · 2024-01-24T15:47:49Z

blacklist feature is now added

eyip002 · 2024-01-24T15:53:17Z

Are you also testing that the initial loading of the game script still works?

noriakisana · 2024-01-24T16:05:30Z

shouldnt work currently cause the dependency selection is broken (need who am I API).

eyip002 · 2024-01-24T16:12:54Z

For pull requests to be merged, the software needs to run correctly. We can't leave the software in a broken state.
You can create a getPlatformName function in the game script that returns the name of the platform as a string. The return value can be hardcoded while #131 is being worked on.

function getPlatformName() {
  return "swtbahn-full";
}

Use this function in the initialise function to select the correct destinations and mappings to use.

Signed-off-by: Jochen Mehlich <[email protected]>

noriakisana · 2024-01-25T13:33:49Z

need to be verified next week on hardware

BLuedtke · 2024-01-25T15:34:42Z

server/src/assets/game/script-game.js

+var allPossibleDestinations = null;
+var signalFlagMap = null;


instead of removing the comments, improve/adapt them to fit the new situation

probably better to keep the old-style comments, which offer a clearer per-variable explanation (i.e., what is each var for)

server/src/assets/game/script-game.js

server/src/assets/game/tableGenerator/Readme.md

BLuedtke · 2024-01-25T15:44:13Z

server/src/assets/game/tableGenerator/Readme.md

+### Map the Signals with the Symbols
+* Create a CSV Document with the following Scheme to the flagMappingsFolder (it should have the same name, like the configuration folder): [signalId],[coloCode]
+* insert your mapping attributes
+* link the csv to generator.py and converter.py


I don't understand what that means

This is not yet resolved, still unclear what this means.

BLuedtke · 2024-01-25T15:44:28Z

server/src/assets/game/tableGenerator/Readme.md

+* link the csv to generator.py and converter.py
+* run generator.py
+* run converter.py
+* link the generated files to the game


what does "link" mean here?

still unclear.

server/src/assets/game/tableGenerator/converter.py

Signed-off-by: Jochen Mehlich <[email protected]>

BLuedtke · 2024-02-23T10:58:28Z

server/src/assets/game/script-game.js

+var signalFlagMap = null;
+
+function getPlatformName(){
+	return "swtbahn-full";


Add a "/// TODO:" here with a comment to indicate that this will need to be adapted once the corresponding server endpoint exists.

(also will have to think about error handling in the future here, as well as blocking this to only return once ready)

server/src/assets/game/script-game.js

BLuedtke · 2024-02-23T11:02:17Z

server/src/assets/game/tableGenerator/Readme.md

+# Table Generator for SWTbahn Game
+
+This python script generates the configuration json files for the swtbahn game client, which are required for the signal-symbol mapping and the route suggestion mechanics.
+The script will automatically find a suitable route (which the least nodes) and store it for the game client, it will do this action only for signals which are listed in the mapping-csv to reduce storage usage.


"The script will automatically find a suitable route" -> to where? The latter part of the sentence implies it is done with all signals from the mapping-csv as the source, but it is not quite clear where these routes are leading.

"which the least nodes" -> grammar/incorrect english; rather say something like "find the shortest possible route from ... /(for all..) to ..." or something like that.

BLuedtke · 2024-02-23T11:03:49Z

server/src/assets/game/tableGenerator/Readme.md

+
+## How to get started
+### Map the Signals with the Symbols
+* Create a CSV Document with the following Scheme to the flagMappings directory (the filename should match with the name of the configuration folder of the model railway): [signalId],[colorCode]  


"Scheme" -> "content formatting"

"to the flagMappings directory" -> "in the flagMappings directory"

BLuedtke · 2024-02-23T11:04:16Z

server/src/assets/game/tableGenerator/Readme.md

+### Map the Signals with the Symbols
+* Create a CSV Document with the following Scheme to the flagMappingsFolder (it should have the same name, like the configuration folder): [signalId],[coloCode]
+* insert your mapping attributes
+* link the csv to generator.py and converter.py


This is not yet resolved, still unclear what this means.

BLuedtke · 2024-02-23T11:04:37Z

server/src/assets/game/tableGenerator/Readme.md

+* link the csv to generator.py and converter.py
+* run generator.py
+* run converter.py
+* link the generated files to the game


still unclear.

Signed-off-by: Jochen Mehlich <[email protected]>

…tity name string Signed-off-by: Jochen Mehlich <[email protected]>

Signed-off-by: Jochen Mehlich <[email protected]>

noriakisana · 2024-03-26T11:37:32Z

works.

eyip002 · 2024-03-29T17:46:34Z

server/src/assets/game/script-game.js

+	namedMap = "allPossibleDestinations_" + platform;
+        str = "allPossibleDestinations =" + namedMap;
+        eval (str);
+        namedMap = "signalFlagMap_" + platform;
+        str = "signalFlagMap =" + namedMap;                  
+        eval (str);


Duplicate code?

eyip002 · 2024-03-29T17:50:53Z

server/src/assets/game/script-game.js

@@ -796,6 +805,16 @@ function initialise() {
 		null                                      // trainId
 	);

+	var platform = getPlatformName();


eyip002 · 2024-03-29T17:51:30Z

server/src/assets/game/script-game.js

+	namedMap = "allPossibleDestinations_" + platform;
+	str = "allPossibleDestinations =" + namedMap;
+	eval (str);
+	namedMap = "signalFlagMap_" + platform;
+        str = "signalFlagMap =" + namedMap;                  
+        eval (str);


Don't reuse variables (namedMap, str) for different purposes!

Why not limit the evaluation to the rhs of each variable assignment?

allPossibleDestinations = eval("allPossibleDestinations_" + platform); signalFlagMap = eval("signalFlagMap_" + platform);

eyip002 · 2024-03-29T18:04:47Z

server/src/assets/game/tableGenerator/converter.py

+    Doing:
+        Roll over all Blocks and search for a RouteID for the destination and insert the details based on start block, destination signal. Data were read from the interlocking table
+    """
+    originalResultData = copy.copy(copy.copy(resultData))


Why double copy?

eyip002 · 2024-03-29T18:11:51Z

server/src/assets/game/tableGenerator/converter.py

+            destinations.append(destination)
+        destinationsSorted = []
+        print(destinations)
+        with open(groupingFile, "r") as csvFile:


Why not just open the readonly file groupingFile once at the start of this function?

better aproach because it closes the file automatically so it use less ressources.

eyip002 · 2024-03-29T18:57:24Z

server/src/assets/game/tableGenerator/converter.py

+    flagMappings = []
+    for entry in mappingFolderContent:
+        if entry.is_file() and entry.name[-4:] == ".csv":
+            flagMappings.append(entry.name[:-4])


Why does flagMappings have to be recomputed all the time?

eyip002 · 2024-03-29T19:00:42Z

server/src/assets/game/tableGenerator/converter.py

+
+    blocktypes = ["blocks", "platforms"]
+
+    for blockType in blocktypes: # Roll over all Blocktypes


What is the goal of this loop? Could be simplified if I knew its goal...

loop over the two blocktypes which we currrently have in our interlocking file (platforms + blocks), but also has the option to extend it, if we need.

eyip002 · 2024-03-29T19:12:36Z

server/src/assets/game/tableGenerator/generator.py

+                if int(number) == 6:
+                    number = 0


Why this? numberToWord(6) would return "Six".

number %= 7

currently we dont have six as symbol

eyip002 · 2024-03-29T19:14:04Z

server/src/assets/game/tableGenerator/Readme.md

+
+## Requirements
+* Python3
+* Configuration w for the model railway


"w"?

Where do you expect the files to be?

eyip002 · 2024-03-29T19:15:37Z

server/src/assets/game/tableGenerator/Readme.md

+![](docs/rw5.png)  
+
+## How to get started
+### Map the Signals with the Symbols


Where is your working directory located?

its relative, so in the same folder like the markdown file - should be fine.

Signed-off-by: Jochen Mehlich <[email protected]>

noriakisana added 12 commits January 10, 2024 13:18

changed settings for swtbahn-standard

c953548

Signed-off-by: Jochen Mehlich <[email protected]>

fixed some references

bbab32f

Signed-off-by: Jochen Mehlich <[email protected]>

added new config files

17e9e57

Signed-off-by: Jochen Mehlich <[email protected]>

fixed typo

e6d4efa

Signed-off-by: Jochen Mehlich <[email protected]>

added last fixed for choose a chair

9e77a3a

Signed-off-by: Jochen Mehlich <[email protected]>

removed signal 1 from destination selection

4a212e6

Signed-off-by: Jochen Mehlich <[email protected]>

added signal 7

36077df

Signed-off-by: Jochen Mehlich <[email protected]>

added documentation to table generator (v0.1)

7688a91

changed table generator (converter) for global usage with all generat…

b1dbbf3

…ion file Signed-off-by: Jochen Mehlich <[email protected]>

changed case for converter when no mappings are there

2cbd10c

Signed-off-by: Jochen Mehlich <[email protected]>

changed table generator (generator.py) for all use

2ae62e4

Signed-off-by: Jochen Mehlich <[email protected]>

updated docs

66a0a72

Signed-off-by: Jochen Mehlich <[email protected]>

noriakisana requested a review from BLuedtke January 24, 2024 12:16

noriakisana self-assigned this Jan 24, 2024

noriakisana requested a review from eyip002 January 24, 2024 12:21

added blacklist filtering method for all-board format

5c2c746

Signed-off-by: Jochen Mehlich <[email protected]>

added hardcoded platform switch

16083c6

Signed-off-by: Jochen Mehlich <[email protected]>

BLuedtke requested changes Jan 25, 2024

View reviewed changes

noriakisana added 5 commits February 14, 2024 10:01

removed spelling inconsistency

845a135

Signed-off-by: Jochen Mehlich <[email protected]>

fixes: overwriting of the dynamic setting of Mapping vars

64c4065

Signed-off-by: Jochen Mehlich <[email protected]>

added comments to the converter.py script

e45d8f5

Signed-off-by: Jochen Mehlich <[email protected]>

adapted comments of line 14-15

d2e5a1c

Signed-off-by: Jochen Mehlich <[email protected]>

added readme fixes to the converter.py readme

3bb9f68

Signed-off-by: Jochen Mehlich <[email protected]>

last readme improvement to converter.py

485ddab

Signed-off-by: Jochen Mehlich <[email protected]>

noriakisana requested a review from BLuedtke February 14, 2024 09:47

BLuedtke requested changes Feb 23, 2024

View reviewed changes

noriakisana added 7 commits February 27, 2024 11:16

converter.py

743b767

Signed-off-by: Jochen Mehlich <[email protected]>

fixes: script-game.js variable commenting

63a2618

Signed-off-by: Jochen Mehlich <[email protected]>

fixes: script-game.js server platform entpoint name api

ebc4fb8

Signed-off-by: Jochen Mehlich <[email protected]>

Readme.md

7ce6468

Signed-off-by: Jochen Mehlich <[email protected]>

Readme.md

c6dc442

Signed-off-by: Jochen Mehlich <[email protected]>

format fix readme tablegenerator

692224d

Signed-off-by: Jochen Mehlich <[email protected]>

converter.py

7d91fe5

Signed-off-by: Jochen Mehlich <[email protected]>

noriakisana marked this pull request as draft March 12, 2024 08:36

noriakisana removed the request for review from eyip002 March 26, 2024 08:20

noriakisana added 5 commits March 26, 2024 12:04

fixes: tablegenerator direct reference to memory string instead of en…

d7990c6

…tity name string Signed-off-by: Jochen Mehlich <[email protected]>

fixes: var declaration

6b71884

Signed-off-by: Jochen Mehlich <[email protected]>

script-game.js

dd73de4

Signed-off-by: Jochen Mehlich <[email protected]>

fixes typo

becf025

Signed-off-by: Jochen Mehlich <[email protected]>

fixes typo

62aaa00

Signed-off-by: Jochen Mehlich <[email protected]>

eyip002 requested changes Mar 29, 2024

View reviewed changes

noriakisana added 5 commits April 13, 2024 16:51

first batch of changes requested by @ey

d318a4e

Signed-off-by: Jochen Mehlich <[email protected]>

second batch of all changes requested

841a6e4

Signed-off-by: Jochen Mehlich <[email protected]>

live fix table generator

c7f6293

Signed-off-by: Jochen Mehlich <[email protected]>

updated readme of tablegenerator

c05ec53

Signed-off-by: Jochen Mehlich <[email protected]>

removed commented

175914a

Signed-off-by: Jochen Mehlich <[email protected]>

		var allPossibleDestinations = null;
		var signalFlagMap = null;


		blocktypes = ["blocks", "platforms"]

		for blockType in blocktypes: # Roll over all Blocktypes

Added general compability for tableGenerator (SWTbahn-Game) #132

Are you sure you want to change the base?

Added general compability for tableGenerator (SWTbahn-Game) #132

Conversation

noriakisana commented Jan 24, 2024

eyip002 commented Jan 24, 2024

noriakisana commented Jan 24, 2024

noriakisana commented Jan 24, 2024

eyip002 commented Jan 24, 2024

noriakisana commented Jan 24, 2024

eyip002 commented Jan 24, 2024

noriakisana commented Jan 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

noriakisana commented Mar 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment