Managing Games

Game records live in _data/games.yml. They supply the games page, game details, and footer links.

Set up a game

Add or edit a record

- slug: example-game
  path: /games/example-game
  status: In development
  image: /assets/img/example-game.png
  effect: false
  engine: Unity
  language: C#
  en-us:
    title: Example Game
    summary: More information will be published as development progresses.
  zh-cn:
    title: 示例游戏
    summary: 随着开发的进行，将发布更多信息。

Every record needs slug, path, status, image, engine, and language. Every configured language also needs its own title and summary.

• A slug is a unique lowercase identifier, such as example-game.
• A path is the unique public address, such as /games/example-game.
• An image path begins with /, and the image must exist in the repository.
• Language keys must match _config.yml; see Localization.

Add the game page

The path must lead to a real page in pages/games/. A simple detail page can use:

---
layout: page
title: Example Game
permalink: /games/example-game
description: Development information for Example Game by PWindows.
game: example-game
---

The permalink must match the record's path, and game must match its slug.

Content and visual effects

Games in development

Do not invent gameplay details for a game marked In development. Use factual, approved information. A short placeholder summary is better than an unsupported promise.

Optional debris effect

The games page can display a decorative image around a game:

  effect: true
  debris:
    path: /assets/img/example-game-debris.png
    scale: 1.5

When effect is true, the debris image must exist. scale is optional, but must be greater than zero when present.

An unfinished effect may keep placeholder debris information while effect is false. Do not enable it until its image exists.

Verify the game

Check the result

• Open /games and the game's detail page locally.
• Confirm the localized title and summary plus the shared status, engine, language, and image.
• Preview /games and /zh-cn/games.
• Check that the footer link opens the correct page.
• Run Running Checks.

Return to Managing Site Data.