Map Tags & Use Maps Server (triplea_maps.yml now unused) #9491
Conversation
__Always use Maps Server__ Stop reading 'triplea_maps.yml' Specifically instead of downloading the 'triplea_maps.yml' file and parsing it, the front end will instead contact the server and receive a JSON payload that contains the map download list. __Introduce and use map tags__ Map tags are a generic way to add additional meta data to maps dynamically. For example, instead of having a 'category' value specifically enumerated, we instead now have a tag whose key is 'category'. This allows us to have an arbitrary set of meta information without needing to update the front end. __Update server to send 'preview image url' to the frontend__ The server computes the preview image URL to make it easier and more explicit for the frontend. Having the server instead of the client compute the preview image URL also allows for it to be updated in database.
Codecov Report
@@ Coverage Diff @@
## master #9491 +/- ##
============================================
- Coverage 28.20% 28.19% -0.01%
- Complexity 8320 8339 +19
============================================
Files 1315 1317 +2
Lines 80996 81019 +23
Branches 11038 11039 +1
============================================
+ Hits 22845 22846 +1
- Misses 55986 56006 +20
- Partials 2165 2167 +2
Continue to review full report at Codecov.
|
|
Is this for the prerelease or effective now ? |
|
@beelee1 |
|
Right on. So does this effect the stable then ? |
|
nope |
Always use Maps Server
Stop reading 'triplea_maps.yml'
Specifically instead of downloading the 'triplea_maps.yml'
file and parsing it, the front end will instead contact
the server and receive a JSON payload that contains the
map download list.
Introduce and use map tags
Map tags are a generic
way to add additional meta data to maps dynamically.
For example, instead of having a 'category' value
specifically enumerated, we instead now have a
tag whose key is 'category'. This allows us to have
an arbitrary set of meta information without
needing to update the front end.
Update server to send 'preview image url' to the frontend
The server computes the preview image URL to make it easier
and more explicit for the frontend. Having the server
instead of the client compute the preview image URL also
allows for it to be updated in database.
Testing
Tested with a local server
./spitfire-server/database/start-docker-dbScreens Shots
The local server is using dummy data, otherwise note that a tag with 'rating' was configured
and is now displayed as a column on the download maps page:
Additional Notes / Warnings
This is going to break the front end for prereleases, specifically download maps might not work.
The deployment of the server needs to happen and even then there is likely more to work out.
Future & Following Work
Release Note
UPDATE|Maps information is now stored in database and no longer stored in the file: 'triplea_maps.yaml'. Game clients now download map information from the server. The game client no longer downloads 'triplea_maps.yaml'. 'Map tag' meta data capability added to database, map admins can add tags to maps and those tags are now displayed by the game client in the download maps screen.