Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.

Home

Jump to bottom
FloofyProtoBomb edited this page Mar 16, 2024 · 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 allows you to easily create a shimmer effect on any GuiObject on Roblox like the example below.

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 Getting Started 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.

Getting Started

You can get started by clicking the links in the sidebar.

🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include :GetFrame() and :GetGradient() which will return their respective Instances. Seek documentation for more details.

Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

Home

Getting Started

Documentation

Clone this wiki locally