Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›App Manifest

API Reference

  • Changelog
  • Overview

App Manifest

  • manifest.json
  • Validate your manifest

Available Game Events

  • Games IDs
  • Apex Legends
  • Call of Duty: Warzone
  • CS:GO
  • Dota 2
  • Final Fantasy XIV
  • Dota Underlords
  • Escape From Tarkov
  • Fortnite
  • Hearthstone
  • Heroes of the Storm
  • Legends of Runeterra
  • League of Legends
  • Minecraft
  • MTG Arena
  • Overwatch
  • Path of Exile
  • PUBG
  • PUBG Lite
  • Rainbow Six Siege
  • Rocket League
  • StarCraft II
  • Teamfight Tactics
  • Valorant
  • World of Tanks
  • World of Warcraft
  • World of Warships
  • Warframe
  • Various External APIs

Game Launchers Events

  • Launchers IDs
  • LOL Launcher

overwolf.benchmarking

  • overwolf.benchmarking

overwolf.campaigns

  • overwolf.campaigns.crossapp

overwolf.cryptography

  • overwolf.cryptography

overwolf.extensions

  • overwolf.extensions
  • overwolf.extensions.current
  • overwolf.extensions.sharedData
  • overwolf.extensions.io

overwolf.games

  • overwolf.games
  • overwolf.games.events
  • overwolf.games.inputTracking
  • overwolf.games.launchers
  • overwolf.games.launchers.events

overwolf.io

  • overwolf.io
  • overwolf.io.paths

overwolf.logitech

  • overwolf.logitech
  • overwolf.logitech.arx
  • overwolf.logitech.led

overwolf.media

  • overwolf.media
  • overwolf.media.audio
  • overwolf.media.replays
  • overwolf.media.videos
  • Highlights supported games

overwolf.os

  • overwolf.os
  • overwolf.os.tray

overwolf.profile

  • overwolf.profile
  • overwolf.profile.subscriptions

overwolf.settings

  • overwolf.settings
  • overwolf.settings.hotkeys
  • overwolf.settings.language
  • overwolf.settings.games

overwolf.social

  • overwolf.social
  • overwolf.social.reddit
  • overwolf.social.youtube
  • overwolf.social.discord
  • overwolf.social.gfycat
  • overwolf.social.twitter

overwolf.streaming

  • overwolf.streaming

overwolf.tobii

  • overwolf.tobii

overwolf.utils

  • overwolf.utils

overwolf.web

  • overwolf.web
  • overwolf.web.webserver
  • overwolf.web.websocket

overwolf.windows

  • overwolf.windows
Edit

Validate your manifest.json

To help you make sure that your manifest file is correct and complete, validate it against our schema file.

You can find the most updated schema in our GitHub repository (and you are welcome to suggest changes/updates).

Online validation

Validate your JSON structure

Make sure that your manifest.json file is a strictly valid JSON, without trailing commas, etc.
You can use jsonlint.com or any other similar services.

Validate your schema

Make sure that your manifest.json file contains only valid Overwolf flags, properties, etc.

  1. Go to jsonschemavalidator.net or similar service like jsonschemalint.com.
  2. Copy-paste the schema's and your manifest.json code into the "Schema" and "Input JSON" windows, respectively.
  3. Check for any errors or missing data.

Automated schema validation

To better follow the modern practices of CI and CD, we strongly recommend you to automate the validation process using your preferred tools.

We demonstrate here how to do that using one of the popular npm schema validation packages, called ajv-cli. Also, the examples here are tested in the terminal of Visual Studio Code.

The steps which developers should take to validate their manifest.json automatically:

1. Install the npm package


> npm install -g ajv-cli

g- install this package globally and make it available for all your projects.

2. Pull the latest manifest

Download the schema from GitHub and save it as overwolf-manifest-schema.json:


> curl -o overwolf-manifest-schema.json "https://raw.githubusercontent.com/overwolf/community-gists/master/overwolf-manifest-schema.json"

o - output name.

3. Validate the data

Validate your manifest.json against the local schema file that you just downloaded (overwolf-manifest-schema.json):


>  ajv validate -s overwolf-manifest-schema.json -d manifest.json
Last updated on 2020-7-19 by eransharv
← manifest.jsonGames IDs →
  • Online validation
  • Automated schema validation
    • 1. Install the npm package
    • 2. Pull the latest manifest
    • 3. Validate the data
  • Legal
  • Terms overview
  • Developer's terms
  • App terms
  • Overwolf terms
  • Overwolf Privacy policy
  • Support
  • Questions and Answers
  • Discord
  • Slack
  • Facebook
  • Twitter
  • Documentation
  • Changelog
  • API
  • App Creation Process
  • Best Practices
  • Game Events status
  • Information
  • Careers
  • Fund
  • Developers Blog
  • Overwolf Appstore
  • Advertise on Overwolf