Skip to content

Images

GDDKit can insert image files or turn clipboard bitmap data into a project asset. It stores generated Markdown in the active section and keeps the file beside the project rather than embedding it in .gddkit.

Insert an image file

  1. Place the caret where the image should appear.
  2. Select the image button in the Markdown toolbar.
  3. Choose a PNG, JPG/JPEG, BMP, or GIF file.
  4. GDDKit copies it to an images/ folder next to the project.
  5. The editor inserts a relative tag such as:
![combat-loop](images/combat-loop.png)

If that filename exists, GDDKit creates combat-loop_1.png, then _2, and so on. The source file is not overwritten.

Paste an image

With the editor focused, Ctrl + V follows this order:

  1. If the clipboard contains a supported local image file, insert that file.
  2. Otherwise, if it contains bitmap data, save it as a timestamped PNG such as clipboard_20260715_142233123.png and insert it.
  3. Otherwise, paste ordinary text.

The generated alt text starts from the filename. Replace it with a short description of the image’s purpose for accessibility and for PDF fallback messages.

Project-relative Markdown image beside its rendered GDDKit preview
A project-relative image path in Markdown renders the local environment image and its caption in Split mode.

The most reliable Markdown pattern

Put the image on its own paragraph:

The combat loop has three feedback horizons.
![Combat loop with immediate, encounter, and meta progression feedback](images/combat-feedback.png)
Use the immediate loop during the first playable tutorial.

The PDF renderer recognizes a standalone image paragraph as an image block. An image embedded inline with other text may fall back to its alt text in PDF.

Local, absolute, and remote sources

SourcePreviewPDFPortability
images/map.pngYesYesBest; relative to the project folder.
Absolute file pathLocal machine onlyCan load locallyPoor; breaks after moving or sharing.
file:///… URLLocal machine onlyCan load locallyPoor and platform-specific.
https://… imageRequires networkRequires network; 10-second request timeout and 8 MB maximumDepends on remote availability.
data: URIMay varyNot supported by the PDF image loaderAvoid.

Remote or missing images do not necessarily cancel PDF export. The PDF can contain a readable fallback box naming the image instead.

GIF, size, and quality

The file picker accepts GIF, but a PDF is static; do not promise animation in exported output. Use a representative still frame when motion is important and link to a video separately.

Very large images increase memory and PDF size. Resize screenshots and references to a sensible reading resolution before insertion. Keep original production art in its asset system rather than turning the GDD into an art archive.

Move or share image-heavy projects

  • Copy the .gddkit file and images/ folder together.
  • Preserve the folder name and relative layout.
  • Markdown export creates the .md file only; copy images/ separately to the export destination.
  • After moving, check a section in Split mode and create a PDF smoke test.
  • If only the project logo is missing, reselect it in Project Details; logo handling is separate from section images.

See Files, assets & backups for a complete portable layout.

When an image does not render

  1. Inspect the Markdown path for spelling and URL encoding.
  2. Confirm the file exists relative to the .gddkit file, not relative to the exported .md file’s new folder.
  3. Put the image tag on a separate paragraph.
  4. For a remote image, test the URL without authentication and check the 8 MB PDF limit.
  5. Reinsert the file with the toolbar to let GDDKit create a safe relative path.