@goodgamestudios/cxf-announcements

Announcements Overview and Workflow

• Logic to display Announcements loaded from RestAPI.
• The repo is also responsible for creating the announcement template files and uploading them to the s3 bucket. here are the 3 templates that we have for now
  • bigfarm_announcement
  • empire_announcement
  • e4k_announcement
• Those templates are used by CXF Admin panel to display preview of the announcements

Integration with the CXF-Plugin

• The announcements package is being used by the cxf-plugins that has JSON files for each game on different stages, the JSON files contain a list of plugins needed within the games, one of those will be the announcement

Deployment of CXF-Plugin

• If you deploy a new version of the announcements, and you needed to release a new version on the cxf-plugin, then do the following

  

  • Within the cxf-plugins repo, create a branch out of the QA branch
  • Update the JSON files with the new version of your announcement package
  • Commit your changes as a "feat" otherwise the repo will not release a new version. push your changes and create MR with QA branch.
  • After reviewing and accepting the MR, create MR with the Master branch, once the MR is approved and merged the cxf-plugin will release a new version automatically.
  • Make sure to invalidate cloudfront for the needed stage and this one for live community-announcements.ggs-stp.com
  • Inform CM and QA about this new version, you can use the slack channel #update_cxf

To test the announcement functionality with the game locally

• Create a couple of announcements for the targeted stage and network instances using the CAP-TOOL the QA works for on staging Env, so better to test on Staging)

• Build the announcement plugin by running:

  npm run build:<STAGE>

• Serve the build folder(dist) locally:

  npm run serve:locally

• Use Requestly or any similar plugin that allows for intercepting a request and redirecting it to another

• Using Requestly , Create a rule to redirect the used announcement plugin to our local one that exists in the dist folder

  We want to redirect from this url https://hotpkg.com/@goodgamestudios/cxf-announcements@qa/dist/announcements.js to the local port that we are running http://127.0.0.1:4002/announcements.js

• Navigate the game or integration page for the wanted game like this one here

  https://html5-game-integration.ggs-ep.com/empire?env=qa&branch=main

• Make sure that you are using the right Network, Server, and instance for the game

• Once you logged in to the game you should be able to see the announcements icon displayed

• Clicking the announcements icon should display the announcements that you created using the CAP tool