Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.
Ryan edited this page Mar 27, 2023 · 9 revisions

Welcome to the Shime wiki! Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject just like how Roblox does.

What is Shime and Shimmer?

Shime is a module that allows you to easily create a shimmer effect on any GuiObject. Shime is used to create a Shimmer class that can be used to create a shimmer effect on any GuiObject.

Shimmer may also be used to describe the Roblox's CoreGui Shimmer module.

Why should I use Shime?

Shime is lightweight and opened-sourced, so you can easily modify it to your liking. It also has familar methods such as Shimmer:Play() and Shimmer:Pause() to control the playback state of the Shimmer, based off the TweenBase class.

Shimmer from Roblox is locked to only CoreGui meaning that normal script can't access it. Shime allows you to create a Shimmer on any GuiObject from any script without needing Roblox Script Security privileges.

How do I use Shime?

To use Shime, you can visit the Usage page to learn how to install Shime. It contains a guide on how to install Shime from GitHub or Roblox and how to use Shime in your scripts. You can also visit the Documentation page to learn more about the Shime and it's constructors, methods, and properties.