Godot Credits Scene

For Godot 4.2+

This credits scene scrolls text that is read from an attribution file in a markdown (.md) format.

Example on itch.io
Example is of Maaack's Game Template, which includes additional features.

Use Case

For adding scrolling credits to your scenes that can auto-update from a project's ATTRIBUTION.md, CONTRIBUTORS.md, or similar attribution markdown file.

Features

• Classic scrolling text.
• Interactable:
  • Supports mouse-wheel and touch-pad scrolling.
  • Supports clicking on external links.
• Generates content from reading an attribution file in markdown (.md) format.
• End Credits example scene.
• Assisted plugin installation.

How it Works

• Credits.tscn reads from ATTRIBUTION.md to automatically generate the content for it's scrolling text label.

Installation

Godot Asset Library

This package is available as a plugin, meaning it can be added to an existing project.

When editing an existing project:

1. Go to the AssetLib tab.
2. Search for "Maaack's Credits Scene".
3. Click on the result to open the plugin details.
4. Click to Download.
5. Check that contents are getting installed to addons/ and there are no conflicts.
6. Click to Install.
7. Reload the project (you may see errors before you do this).
8. Enable the plugin from the Project Settings > Plugins tab.
   If it's enabled for the first time,
   1. A dialogue window will appear asking to copy the example scenes out of addons/.
9. Continue with the Existing Project Instructions

GitHub

1. Download the latest release version from GitHub.
2. Extract the contents of the archive.
3. Move the addons/maaacks_credits_scene folder into your project's addons/ folder.
4. Open/Reload the project.
5. Enable the plugin from the Project Settings > Plugins tab.
   If it's enabled for the first time,
   1. A dialogue window will appear asking to copy the example scenes out of addons/.
6. Continue with the Existing Project Instructions

Extras

Users that want additional features can try Maaack's Game Template.

Usage

Changes can be made directly to scenes and scripts outside of addons/.

A copy of the examples/ directory is made outside of addons/ when the plugin is enabled for the first time. However, if this is skipped, it is recommended developers inherit from scenes they want to use, and save the inherited scene outside of addons/. This avoids changes getting lost either from the package updating, or because of a .gitignore.

Existing Project

Existing Project Instructions

Links

Attribution
License