MrUnknownDE/examples-image-loading
1
0
Fork 0
mirror of https://github.com/MrUnknownDE/examples-image-loading.git synced 2026-04-10 18:33:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Publishes Readme

Browse Source
This commit is contained in:
Momo The Monster
2023-02-15 22:39:12 -08:00
parent f28e5db8c8
commit 7ed383f438
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
Readme.md
View File

@@ -35,4 +35,15 @@ The basic logic flow of the script is this:
* On Start, construct a VRCImageDownloader to reuse for downloading all the images. It's important to keep this around so the textures will persist. Download the string from the `String Url`.
* If the String downloads successfully, split it up line-by-line into separate strings, and save those to a `_captions` array. If it doesn't download, log the error message.
* Next, try to Load the next Image. Increment the `_loadedIndex` to keep track of our place, then call `DownloadImage()` on the downloader we saved earlier.
* If the Image downloads successfully, save a reference to it.
* If the Image downloads successfully, save a reference to it and then load it up on the `Renderer`. If it fails, log the error message.
* Call the function to Load the next Image again, delayed by `SlideDurationSeconds`. The `_loadedIndex` is incremented during each Load call, and starts over after reaching the last url in the array.
* When each image is visited for the second+ time, it will be displayed from its saved Texture2D reference instead of loaded fresh, unless it failed to download the first time.
## Known Issues
* The first image doesn't have its caption loaded quickly enough, so it doesn't show until the first loop around.
* The way I'm doing pseudo-sync could use some review. I _think_ it makes sense but I haven't tested it much.
## Using GitHub to Host the Images and Captions
This repo publishes to [GitHub Pages](https://pages.github.com/) for free hosting of the images and captions. When the files in the "Web" directory are edited, the website is re-published. As long as the filenames stay the same (images are 1.jpg, 2.jpg, etc.) - the URLs in the world will point to the newly published files. Republishing happens automatically through [an included GitHub Action](https://github.com/vrchat-community/examples-image-loading/actions/workflows/static.yml).