Skip to content
This repository has been archived by the owner on Sep 3, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ixjf authored Nov 30, 2018
1 parent 61359fb commit 11e4c66
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Scripts are written in Lua and allow you to create new effects. Lua is a very ea

Scripts are loaded from the 'Scripts' folder in the directory where you have saved MSIRGB. Any file with a .lua extension in that folder (subdirectories excluded) will be loaded. The name of the script that will appear on MSIRGB is the file name without extension. As a convention, you should use upper camel case and spaces between words for your file names, e.g. 'Hue Wheel', 'Single Colour', 'Edgy Rainbow'.

I'm open to pull requests for new scripting functionality. I'll also be opening an issue regarding the ability to use 'require' and whether it's worth it.

Scripts, when enabled, run on Windows startup, so you don't have to enable them every time.

It is recommended that scripts set all LED settings on startup because there are no guarantees on their state at that point.

I'm open to pull requests for new scripting functionality. I'll also be opening an issue regarding the ability to use 'require' and whether it's worth it.

## API
Scripts are loaded into a sandboxed Lua 5.2 environment with the following standard functions and packages:
- assert
Expand Down

0 comments on commit 11e4c66

Please sign in to comment.