Skip to main content

ST String Downloader

Downloads a small text file, such as a list of names, a message of the day or settings, like VRChat's VRCStringDownloader. Add it with Add Component → StageTime → ST String Downloader.

Approved sources are coming

In a future SDK update, ST String Downloader will only load from an approved list of sources, and links to other sites will stop loading. The list will be published in these docs before the change. See the Roadmap.

Field
urlThe https link to download
loadOnStartDownload when the world loads
cacheMinutesReuse a downloaded copy for this many minutes, also after rejoining (default 5; 0 = always download)

The text can be up to 16,384 characters (the longest string a script can hold). For larger lists, use an ST Data Table, which keeps the data out of your script.

Member
resultThe downloaded text after OnStringLoadSuccess
errorWhy the last download failed
isLoadingA download is in progress
Load(), LoadUrl(url)Download again, or another link

Scripts on the same GameObject get OnStringLoadSuccess() and OnStringLoadError(). Each player's device downloads the file. A failed download uses an older cached copy when there is one.

public class Message : StageTimeBehaviour
{
public TMP_Text label;

public override void OnStringLoadSuccess() => label.text = GetComponent<STStringDownloader>().result;
public override void OnStringLoadError() => label.text = "Could not load the message";
}

Unlike VRChat, the events carry no parameter: read result or error from the component. Links are plain strings (no VRCUrl), https only. All of a world's downloads share a limit of one new request per second; extra requests wait their turn.