Adds a link bacl to campaign trackers

If the player comes from the Gloomhaven Storyline app then there is now a menu item to get back to it. Otherwise the app acts exactly as it did before

Author: hobnob

VirtualGloomhavenBoard/Elm/src/AppStorage.elm

@@ -1,11 +1,11 @@
-port module AppStorage exposing (AppModeType(..), AppOverrides, Config, GameModeType(..), MoveablePiece, MoveablePieceType(..), decodeMoveablePiece, empty, emptyOverrides, encodeMoveablePiece, loadFromStorage, loadOverrides, saveToStorage)
+port module AppStorage exposing (AppModeType(..), AppOverrides, CampaignTrackerUrl(..), Config, GameModeType(..), MoveablePiece, MoveablePieceType(..), decodeMoveablePiece, empty, emptyOverrides, encodeMoveablePiece, loadFromStorage, loadOverrides, saveToStorage)
 
 import BoardOverlay exposing (BoardOverlay)
 import Character exposing (CharacterClass, stringToCharacter)
 import Game exposing (GameState, Piece)
 import GameSync exposing (decodeGameState, decodePiece, encodeGameState, encodeOverlay, encodePiece)
 import Html exposing (s)
-import Json.Decode as Decode exposing (Decoder, andThen, decodeValue, fail, field, map2, map4, map5, map6, maybe, string, succeed)
+import Json.Decode as Decode exposing (Decoder, andThen, decodeValue, fail, field, map2, map4, map5, map6, map7, maybe, string, succeed)
 import Json.Encode as Encode exposing (object, string)
 import List exposing (filterMap)
 import SharedSync exposing (decodeBoardOverlay)
@@ -26,6 +26,7 @@ type alias Config =
     , roomCode : Maybe String
     , showRoomCode : Bool
     , boardOnly : Bool
+    , campaignTracker : Maybe CampaignTrackerUrl
     }
 
 
@@ -36,9 +37,14 @@ type alias AppOverrides =
     , lockScenario : Bool
     , lockPlayers : Bool
     , lockRoomCode : Bool
+    , campaignTracker : Maybe CampaignTrackerUrl
     }
 
 
+type CampaignTrackerUrl
+    = CampaignTrackerUrl String String
+
+
 type GameModeType
     = MovePiece
     | KillPiece
@@ -70,7 +76,7 @@ type MoveablePieceType
 
 emptyConfig : Config
 emptyConfig =
-    Config Game MovePiece Nothing True False
+    Config Game MovePiece Nothing True False Nothing
 
 
 empty : ( GameState, Config )
@@ -80,7 +86,7 @@ empty =
 
 emptyOverrides : AppOverrides
 emptyOverrides =
-    AppOverrides Nothing Nothing Nothing False False False
+    AppOverrides Nothing Nothing Nothing False False False Nothing
 
 
 saveToStorage : GameState -> Config -> Cmd msg
@@ -131,6 +137,14 @@ encodeConfig config =
           )
         , ( "showRoomCode", Encode.bool config.showRoomCode )
         , ( "boardOnly", Encode.bool config.boardOnly )
+        , ( "campaignTracker"
+          , case config.campaignTracker of
+                Just t ->
+                    Encode.object (encodeCampaignTrackerUrl t)
+
+                Nothing ->
+                    Encode.null
+          )
         ]
 
 
@@ -184,7 +198,7 @@ storedDataDecoder =
 
 appOverridesDecoder : Decoder AppOverrides
 appOverridesDecoder =
-    map6 AppOverrides
+    map7 AppOverrides
         (field "initScenario" (maybe Decode.int))
         (field "initPlayers"
             (maybe (Decode.list Decode.string)
@@ -199,16 +213,18 @@ appOverridesDecoder =
         (field "lockScenario" Decode.bool)
         (field "lockPlayers" Decode.bool)
         (field "lockRoomCode" Decode.bool)
+        (field "campaignTracker" (maybe decodeCampaignTrackerUrl))
 
 
 decodeConfig : Decoder Config
 decodeConfig =
-    map5 Config
+    map6 Config
         (field "appMode" (Decode.string |> Decode.andThen decodeAppMode))
         (field "gameMode" (Decode.string |> Decode.andThen decodeGameMode))
         (field "roomCode" (Decode.nullable Decode.string))
         (field "showRoomCode" Decode.bool)
         (maybe (field "boardOnly" Decode.bool) |> andThen (\b -> succeed (Maybe.withDefault False b)))
+        (maybe (field "campaignTracker" decodeCampaignTrackerUrl))
 
 
 decodeAppMode : String -> Decoder AppModeType
@@ -310,6 +326,16 @@ decodeCoords =
             )
 
 
+decodeCampaignTrackerUrl : Decoder CampaignTrackerUrl
+decodeCampaignTrackerUrl =
+    field "name" Decode.string
+        |> andThen
+            (\name ->
+                field "url" Decode.string
+                    |> andThen (\url -> Decode.succeed (CampaignTrackerUrl name url))
+            )
+
+
 encodeMoveablePiece : MoveablePiece -> Encode.Value
 encodeMoveablePiece piece =
     Encode.object
@@ -378,3 +404,10 @@ encodeCoords ( x, y ) =
     [ ( "x", Encode.int x )
     , ( "y", Encode.int y )
     ]
+
+
+encodeCampaignTrackerUrl : CampaignTrackerUrl -> List ( String, Encode.Value )
+encodeCampaignTrackerUrl tracker =
+    case tracker of
+        CampaignTrackerUrl name url ->
+            [ ( "name", Encode.string name ), ( "url", Encode.string url ) ]

VirtualGloomhavenBoard/Elm/src/Main.elm

@@ -1,6 +1,6 @@
 port module Main exposing (main)
 
-import AppStorage exposing (AppModeType(..), Config, GameModeType(..), MoveablePiece, MoveablePieceType(..), decodeMoveablePiece, emptyOverrides, encodeMoveablePiece, loadFromStorage, loadOverrides, saveToStorage)
+import AppStorage exposing (AppModeType(..), CampaignTrackerUrl(..), Config, GameModeType(..), MoveablePiece, MoveablePieceType(..), decodeMoveablePiece, emptyOverrides, encodeMoveablePiece, loadFromStorage, loadOverrides, saveToStorage)
 import Array exposing (Array, fromList, length, toIndexedList, toList)
 import Bitwise
 import BoardMapTile exposing (MapTileRef(..), refToString)
@@ -230,6 +230,13 @@ init ( oldState, maybeOverrides, seed ) =
 
                                         Nothing ->
                                             c.roomCode
+                                , campaignTracker =
+                                    case overrides.campaignTracker of
+                                        Just t ->
+                                            Just t
+
+                                        Nothing ->
+                                            c.campaignTracker
                               }
                             )
 
@@ -1056,14 +1063,15 @@ view model =
         , id "content"
         , Touch.onCancel (\_ -> TouchCanceled)
         ]
-        ([ lazy7
+        ([ lazy8
             getHeaderHtml
             model.game.scenario.id
             model.game.scenario.title
             model.config.roomCode
             model.config.showRoomCode
             model.lockScenario
             model.lockPlayers
+            model.config.campaignTracker
             model.menuOpen
          , div [ class "main" ]
             [ div
@@ -1204,8 +1212,8 @@ subscriptions _ =
         ]
 
 
-getHeaderHtml : Int -> String -> Maybe String -> Bool -> Bool -> Bool -> Bool -> Html.Html Msg
-getHeaderHtml scenarioId scenarioTitle roomCode showRoomCode lockScenario lockPlayers menuOpen =
+getHeaderHtml : Int -> String -> Maybe String -> Bool -> Bool -> Bool -> Maybe CampaignTrackerUrl -> Bool -> Html.Html Msg
+getHeaderHtml scenarioId scenarioTitle roomCode showRoomCode lockScenario lockPlayers campaignTracker menuOpen =
     div
         [ class "header" ]
         [ div
@@ -1231,7 +1239,17 @@ getHeaderHtml scenarioId scenarioTitle roomCode showRoomCode lockScenario lockPl
                     "false"
                 )
             ]
-            [ lazy3 getMenuHtml lockScenario lockPlayers menuOpen ]
+            [ let
+                ( campaignTrackerName, campaignTrackerUrl ) =
+                    case campaignTracker of
+                        Just (CampaignTrackerUrl name url) ->
+                            ( Just name, Just url )
+
+                        Nothing ->
+                            ( Nothing, Nothing )
+              in
+              lazy6 getMenuHtml lockScenario lockPlayers scenarioId campaignTrackerName campaignTrackerUrl menuOpen
+            ]
         , header [ attribute "aria-label" "Scenario" ]
             (if scenarioId /= 0 then
                 [ span [ class "number" ] [ text (String.fromInt scenarioId) ]
@@ -1481,8 +1499,8 @@ getNewPieceHtml gameMode currentDraggable hasDiviner bearSummoned nextSummonsId
         |> Dom.render
 
 
-getMenuHtml : Bool -> Bool -> Bool -> Html.Html Msg
-getMenuHtml lockScenario lockPlayers menuOpen =
+getMenuHtml : Bool -> Bool -> Int -> Maybe String -> Maybe String -> Bool -> Html.Html Msg
+getMenuHtml lockScenario lockPlayers scenarioId campaignTrackerName campaignTrackerUrl menuOpen =
     Dom.element "nav"
         |> Dom.addAttribute
             (attribute
@@ -1544,7 +1562,24 @@ getMenuHtml lockScenario lockPlayers menuOpen =
                                 |> Dom.addClass "section-end"
                                 |> Dom.appendText "Settings"
                                 |> shortcutHtml [ "⇧", "s" ]
-                           , Dom.element "li"
+                           ]
+                        ++ (case ( campaignTrackerName, campaignTrackerUrl ) of
+                                ( Just name, Just url ) ->
+                                    [ Dom.element "li"
+                                        |> Dom.addAttribute (attribute "role" "menuitem")
+                                        |> Dom.addAttribute (tabindex 0)
+                                        |> Dom.appendChild
+                                            (Dom.element "a"
+                                                |> Dom.addAttribute (href (String.replace "{scenarioId}" (String.fromInt scenarioId) url))
+                                                |> Dom.addAttribute (target "_new")
+                                                |> Dom.appendText name
+                                            )
+                                    ]
+
+                                _ ->
+                                    []
+                           )
+                        ++ [ Dom.element "li"
                                 |> Dom.addAttribute (attribute "role" "menuitem")
                                 |> Dom.addAttribute (tabindex 0)
                                 |> Dom.appendChild

VirtualGloomhavenBoard/wwwroot/js/app.js

@@ -185,6 +185,15 @@
                 o.initRoomCodeSeed = seed;
         }
 
+        if (document.referrer !== "") {
+            if (document.referrer.includes("gloomhaven-storyline.com")) {
+                o.campaignTracker = {
+                    name: "Gloomhaven Storyline",
+                    url: "https://gloomhaven-storyline.com/#/story/{scenarioId}"
+                }
+            }
+        }
+
         return o;
     }