The ReadMetadata() API allows you to read the metadata that is passed into the game when it loads. This is used by the Pixel Vision 8 Runner to pass data between load sessions. When a game is restarted, it will get a copy of the original metadata that was used to launch the game for the first time. The metadata is eventually cleared as the Runner loads new games, so it’s important to save any of the metadata you need between sessions to the game’s saves.json file. Finally, all keys and values are strings. This means if you are reading an integer or boolean, you’ll need to convert it in order to get its native type.

ReadMetaData ( key, defaultValue )

The Pixel Vision 8 Runner adds the following metadata keys whenever it loads up a game:

In this example, we are going to iterate over all of the game’s metadata keys and output what we can to the display. Running this code will output the following:

function Init()

  -- Example Title
  DrawText("ReadMetadata()", 8, 8, DrawMode.TilemapCache, "large", 15)
  DrawText("Lua Example", 8, 16, DrawMode.TilemapCache, "medium", 15, -4)
  
  -- Display the name of the game from the game's metadata
  DrawText("Game Name:", 1, 4, DrawMode.Tile, "large", 15)
  DrawText(ReadMetadata("GameName", "Untitled"), 12, 4, DrawMode.Tile, "large", 14)

end

function Draw()
  -- Redraw the display
  RedrawDisplay()
end

namespace PixelVision8.Player
{
    class ReadMetadataExample : GameChip
    {

        public override void Init()
        {

            // Example Title
            DrawText("ReadMetadata()", 8, 8, DrawMode.TilemapCache, "large", 15);
            DrawText("C Sharp Example", 8, 16, DrawMode.TilemapCache, "medium", 15, -4);

            // Display the name of the game from the game's metadata
            DrawText("Game Name:", 1, 4, DrawMode.Tile, "large", 15);
            DrawText(ReadMetadata("GameName", "Untitled"), 12, 4, DrawMode.Tile, "large", 14);

        }

        public override void Draw()
        {

            // Redraw the display
            RedrawDisplay();

        }
    }
}