Simple Scrolling Credits (update)

Description

This is an updated version of Simple Scrolling Credits designed for most configuration via URL parameters. See the changelog at the bottom.

Example of credits in Streamer.bot using a simple scrolling style that allows for easy font and color changes in an editor as well as including intro and outro text/images.

Note: Original code for these credits were taken from a Codepen fork where it’s true original author could not be ascertained


Included:

  • Zipped folder with HTML, JS, and CSS files
  • Video describing steps involved in adding, editing and styling credits

Files

Latest Version:
Credits - Simple Scrolling-2026-03-19.zip (22.4 KB)
scrollingCredits-0.2.0.sb (7.0 KB)

Older versions:
Credits - Simple Scrolling-2025-04-01.zip (15.3 KB)
Credits - Simple Scrolling-2024-11-03.zip (8.2 KB)
Credits - Simple Scrolling-2024-09-21.zip (4.9 KB)
Credits - Simple Scrolling-2024-09-08.zip (4.3 KB)

Download the files needed by clicking the link above and extract the folder to where you save your files used in your stream

If you are updating from an old version, please ensure you keep a backup of changes you’ve made to the script.js or style.css files!

const headers has been moved from script.js into its own headers.js file!

Configuration

Enable Streamer.bot WebSocket Server

  • In Streamer.bot, open the tab Server/Clients > WebSocket Server (the first tab)
  • Make sure the WebSocket Server is enabled

URL Parameters

Configuration changes can now be made by using URL parameters without having to edit the JavaScript. These are all optional and will work by default on WebSocket 127.0.0.1:8080

Read more about URL Parameters at the following articles:

Video about URL Parameters

URL Param Name Description Default Value
host Streamer.bot WebSocket server host 127.0.0.1
port Streamer.bot WebSocket server port 8080
scrollingSpeedPercent Control the scrolling speed. i.e. use 200 for 2x speed 100
iterations Number of times to repeat the credits Infinity
removeBroadcaster Remove the broadcaster and bot names from the credits true
testCredits Set to true to play credits with random test values instead of live data false
introImageUrl URL for intro image; place an image at the top of the credits
introText Text to put at the top of the credits
introImageFirst Set to true if you want the intro image to appear before the intro text
NOTE: both introImageUrl and introText must be used
false
outroImageUrl URL for outro image; place an image at the bottom of the credits
outroText Text to put at the bottom of the credits
outroImageFirst Set to true if you want the outro image to appear before the outro text
NOTE: both outroImageUrl and outroText must be used
false
creditsDuration This value (in seconds) will tell the credits to scroll at a speed to aim to be around this value. e.g. 90 would make the credits scroll at a speed that would take about 90 seconds to fully scroll through 0
pixelSpeed Use this if you want to fully control the scrolling speed. This URL parameter overrides creditsDuration and scrollingSpeedPercent 0.06
excludeUsers This will retrieve the list of users in a User Group from Streamer.bot false
groupName This is the name of the User Group from Streamer.bot to retrieve a list of users to exclude. Excluded From Credits
excludeAccidentalArgs If an entry shows an unintentional empty argument (example: %user% donated %bits% bits), exclude it from the credits true

URL parameter hierarchy for scrolling speed URL parameters:
pixelSpeed overrides
creditsDuration overrides
scrollingSpeedPercent

Examples of URL parameters

Expand for more examples of file:// URL with URL parameters set Using a different host and port - `file:///D:/streamerbot-exports/Credits/Credits%20-%20Simple%20Scrolling/index.html?host=192.168.69.69&port=8081`

Displaying credits with 200% (2x) faster scrolling

  • file:///D:/streamerbot-exports/Credits/Credits%20-%20Simple%20Scrolling/index.html?scrollingSpeedPercent=200

Using test credits

  • file:///D:/streamerbot-exports/Credits/Credits%20-%20Simple%20Scrolling/index.html?testCredits=true

By default, credits will forever. To play credits only once

  • file:///D:/streamerbot-exports/Credits/Credits%20-%20Simple%20Scrolling/index.html?iterations=1

Example of all of the above put together

  • file:///D:/streamerbot-exports/Credits/Credits%20-%20Simple%20Scrolling/index.html?host=192.168.69.69&port=8081&scrollingSpeedPercent=200&testCredits=true&iterations=1

Use the Generator to create your Credits URL

  • Open the generator.html file in your web browser
  • Customize the options as needed
    • Parameters are explained in the URL Parameters section below
  • Click the Copy button next to the URL to copy it so you can paste it into a browser source in OBS.
  • Alternatively, use the URL generator found here: Streamer.bot Config

Add credits browser source to OBS

  1. As shown above, get the file:// URL for your credits index.html file
  2. In OBS, create a browser source
  3. Paste the URL copied
    • If you are changing any settings with URL parameters, paste them to the end of the URL
    • A description of each setting is provided in the URL Parameters section
  4. Set Width and Height to your canvas resolution
  5. Enable Shutdown source when not visible
  6. Enable Refresh browser when scene becomes active
  7. Press OK to save changes

Editing/Styling

The credits are styled using the included CSS file styles.css. While some of the more advanced changes will take a basic understanding of web development changing the two colors and (to a certain degree) the fonts are not complicated things to do. You will need a text editor. If you are working with an unaltered style.css you fill find the following sections on the listed line of the editor:

  • Font Class Import (Google Font) ---- Line 1
  • Font Name and Size ------------------- Line 21
  • RGB Color Code For Names Listed – Line 24
  • RGB Color Code for Titles/Sections – Line 37

Customizing headers

The headers array was previously located at the top of the script.js file. The array is now in its own headers.js file.

The headers array is how you can customize what shows in the credits. It may not be obvious, but the order of the array will be the order of the shown credits.

  1. section - consists of events, hypeTrain, users, groups, or custom
    • events, hypeTrain, and users are mainly Twitch only events selected in Streamer.bot > Services > Credits
    • groups are selected User Groups selected in Streamer.bot > Services > Credits
    • custom is added manually through the CPH.AddToCredits C# method. More details in the following section called Adding Custom Credits
  2. key - this is used for identifying specific type of credit category, important for identifying custom data
  3. title - This is header title you see in the credits
  4. filterExistingEntries (optional) - setting to true will hide identical names/strings in that section

Example header

{ section: "custom", key: "bussin", title: "Bussin'"  },

Remember, this is a JavaScript object in an array and not JSON!

Adding Custom Credits

Custom credits can be added with the C# method CPH.AddToCredits. Then you’d have to add a matching section in in the const headers array located in the headers.js file.

Included in the .sb is an action for adding custom credits without having to dive into C# code:

  1. Duplicate the action Scrolling Credits - Add to Credits Example
  2. Enable the Set Argument %creditsCategory% edit the value to give it a unique name
    • Ensure the value is all lowercase and no spaces
    • creditsCategory must match the key in the JavaScript headers array explained above
  3. Edit the Set Argument %creditsMessage% to be whatever you want to display in the credits.
    • You can even use variables here so you can theoretically show donors and the amount they donated

Excluding Users

Let’s say, for example, you ban users and don’t want them to appear in the credits. With Streamer.bot, you can add users to a User Group. In the Scrolling Credits, you can tell it to exclude users who are in a User Group.

By default, if excludeUsers is set to true and no groupName is provided, it will look for a User Group called Excluded From Credits.

In Streamer.bot > Settings > Groups, add a group called Excluded From Credits. Use your preferred method of adding users to that User Group. Ensure excludeUsers is set to true in the URL parameters of the file:// URL. Any users in this group will not be shown in the credits.

Video from the original Scrolling Credits creator Lyfesaver74

Changelog

2026-06-22

New
+ New action to add all users in a User Group to credits via scrollingCredits-0.2.0.sb

2026-03-19

New
+ Ability to filter out credits containing blank arguments (e.g. %user%, but the variable was never populated), enabled by default. Disable by setting excludeAccidentalArgs to false
+ Ability to exclude users in one or more User Groups
+ Streamer.bot Import for getting User Groups data and adding custom credits data

Updated
+ Moved headers into its own headers.js file for modularity (and easier upgrading)
+ URL parameter generator now include options for excluding users contained in User Groups
+ Includes Streamer.bot Client v1.12.2

Fix
- filterExistingEntries wasn't actually removing duplicate names from sections. Trying a different method that seems to work better

2025-04-01

No, this is not a joke

+ Included copy of Streamer.bot Client 1.9.5 for offline usage (to mitigate when unpkg is down)
+ Modified generator.js to encode URI for parameters
+ Added introText, introImageUrl, outroText, outroImageUrl to style.css file
- This fixed a bug with the height of the images not being added to the calculated duration, causing credits to end early 

2024-11-03

+  Added a generator html file for configuration with a GUI

2024-09-21

New
+ Added new URL parameters (see below)

Updated
+ If the scrolling speed is too slow (`pixelSpeed < 0.0120`), it will apply the default pixelSpeed instead

Fixed
- Bug with `scrollingSpeedPercent` when trying to use a value less than `100`

New URL Parameters:

URL Param Name Description Default Value
creditsDuration This value (in seconds) will tell the credits to scroll at a speed to aim to be around this value. e.g. 90 would make the credits scroll at a speed that would take about 90 to fully scroll through
pixelSpeed Use this if you want to fully control the scrolling speed. This URL parameter overrides creditsDuration and scrollingSpeedPercent 0.06

2024-09-08

New
+ Added configurable scrolling speed using percent, starting from 100
+ Added hiding of broadcaster and bot name by default, can be configured to show if desired via URL parameter

Updated
+ Most configuration is now done via URL parameters, see the `Configuration` section
+ Updated JavaScript to use [Streamer.bot Client](https://streamerbot.github.io/client/)
+ Moved headers array to the top of the JavaScript file `script.js` for simpler configuration of header titles
2 Likes

The first attempts at editing worked :slight_smile:

It’s great that it works again.

My only question is about the scrolling speed:

const scrollingSpeed ​​= parseInt(params.get(‘scrollingSpeedPercent’)/100, 10) || 0.25;

you write that the target is 100 (changing this value, nothing happens - for me). Only the last digit (default 1), changed to a smaller one, slows down the scrolling of the subtitles.

Great job. Thank you.

The idea behind the changes are so that you don’t need to touch the code in order to change the scrolling speed. Just add a URL parameter to the browser source URL.

I’ve already updated the documentation on URL parameters, how to use them, and examples.

To get 200% (2x) scrolling speed:

file:///D:/overlays/credits/Credits - Simple Scrolling/index.html?scrollingSpeed=200

I understand, but entering a parameter like 25 doesn’t slow me down (it still scrolls at 100%). I tried 0.25 0.25 doesn’t slow anything down. Only the method in the code I gave me worked so that it didn’t scroll at 100% but only for me.

my link:
file:///E:/(…)/Credits%20-%20Simple Scrolling2/Credits%20-%20Simple Scrolling/index.html?scrollingSpeedPercent=50

(…) - my path in hard disc

Unless you have another tip :slight_smile:

I m using the html file shared by Haunter on discord. It works great and i haven’t touched anything yet besides the fonts. However, I noticed that it does not register the YT New subscribers even tho some of them had their google accounts public which is weird. Can it be related to any change in the variable?

Another great job. This generator is great.

I didn’t encounter an error.

Thx to you time and help :slight_smile:

1 Like

it cool update for kick and separated too since kick finally open api

How would I be able to activate credits for Kofi Donations? May be also summed up if a user sent multiple kofi donos in the same stream?

@rondhi I have created a variant of this which scrolls horizontally, rather than vertically, and which re-gets the credits info at the end of each full scroll. Are you interested in pulling those changes back into this master version?

(Edit: I originally asked about the license, but I’ve now found the page saying everything is GPL, so removed that question!)