Docs

Everything the Godot and Unity plugins can do, and the HTTP API for any other engine. Use the key pxd_sandbox to try anything here: you get example cards and nothing is recorded.

Godot plugin

Project settings

Project, Project Settings, Pixeldoor.

Card properties

Select the card in your scene and change these in the inspector.

Ready-made scenes

All in addons/pixeldoor. Drag one into your scene and change its settings in the inspector. See where to put them for ideas.

Each one has its own wording settings (title, message, button text) and the same card settings as above: Placement, Source and Picks.

# Show the loading screen, load the level in the background,
# and switch the moment it's loaded. The card never holds it up.
PixeldoorLoadingScreen.change_scene("res://levels/level_2.tscn")

# Your own loading code instead:
var screen := PixeldoorLoadingScreen.open()
screen.set_progress(0.5)   # 0.0 to 1.0 as you go
screen.close()             # the moment you're done

Custom cards

Make cards for your own news in your dashboard: a Kickstarter, your next game, a sale, your Discord or soundtrack. Run as many as you like, each on the screens you choose, and A/B test the wording. Any card with Source set to mine shows them first while they’re running, then your other games. Nothing to change in your game, and no patch when you change a card. Plugin 0.5.0 and later shows each card’s label and button text.

Script functions

The plugin adds a Pixeldoor autoload. The card uses these, and so can you:

# Build your own card with the plugin's functions
func _ready() -> void:
    var games: Array = await Pixeldoor.fetch_feed(1, "pause", "mine")
    if games.is_empty():
        return  # offline or nothing to show: just don't show a card
    var g: Dictionary = games[0]
    $Title.text = g.name
    $Art.texture = await Pixeldoor.load_image(g.image_url)
    Pixeldoor.report_impression(g)              # once it's actually visible
    $Button.pressed.connect(func(): Pixeldoor.open_store(g))

Unity plugin

Unity 2021.3 or newer, any render pipeline. Download pixeldoor-unity-0.1.0.tgz, then Window, Package Manager, +, Add package from tarball. Text uses TextMeshPro when your project has it set up.

using PixeldoorSdk;

// Loads the scene in the background and switches the moment it's ready.
PixeldoorLoadingScreen.ChangeScene("Level2");

// Or with your own loading code:
var screen = PixeldoorLoadingScreen.Open();
screen.SetProgress(0.5f);   // 0 to 1 as you go
screen.Close();             // the moment you're done

Build your own card with Pixeldoor.FetchFeed, LoadImage, ReportImpression and OpenStore. With Steamworks.NET or Facepunch.Steamworks in your game, clicks open the Steam overlay; with IL2CPP stripping on, add the link.xml from the package’s README.

using PixeldoorSdk;

var games = await Pixeldoor.FetchFeed(1, "pause", PromoSource.Mine);
if (games.Count == 0) return;                      // offline or nothing to show
myRawImage.texture = await Pixeldoor.LoadImage(games[0].image_url);
Pixeldoor.ReportImpression(games[0]);             // once it's on screen
myButton.onClick.AddListener(() => Pixeldoor.OpenStore(games[0]));  // also logs the click

HTTP API

Base URL https://pixeldoor.app. Send your key in the X-Promo-Key header.

GET /api/v1/feed

{
  "serve_id": "9d75be5b-3fb5-488a-b093-dd570e4ba0fb",
  "source": "network",
  "games": [
    {
      "id": "a1b2…",
      "slug": "their-game",
      "name": "Their Game",
      "tagline": "One short line.",
      "steam_app_id": 1234560,
      "image_url": "https://…/header.jpg",
      "link_url": "https://store.steampowered.com/app/1234560/?utm_source=pixeldoor&…"
    }
  ]
}

source tells you what you actually got, which is network if a fallback happened. Custom cards come back first on source=mine with "kind": "custom" and optional label and button_text; report their impressions and clicks the same way. steam_app_id is 0 for games that aren’t on Steam.

POST /api/v1/events

Send impression once a card is on screen and click when it’s clicked. Batch up to 50 and send every few seconds, plus right away on a click. Duplicates are ignored.

{
  "events": [
    { "serve_id": "9d75…", "game_id": "a1b2…", "kind": "impression" },
    { "serve_id": "9d75…", "game_id": "a1b2…", "kind": "click", "ms_since_shown": 4200 }
  ]
}

Opening the store

No overlay? Open steam://openurl/ followed by link_url if Steam is installed, or link_url in the browser if it isn’t.