Sol

Description

Sol is a library of useful functions and ways to get game data. It is intended to to help addon developers with common tasks.

See the API for details

Packages currently include

• Sol.animation
• Sol.chat
• Sol.color
• Sol.config
• Sol.hooks
• Sol.io
• Sol.math
• Sol.string
• Sol.timers
• Sol.table
• Sol.tooltip
• Sol.util
• Sol.data
  • Sol.data.crafts
  • Sol.data.frames
  • Sol.data.items
  • Sol.data.quests
  • Sol.data.skills

To use Sol

• Include Sol.lua and LibStub.lua with your addon's files
• Add LibStub.lua followed by Sol.lua to your .toc, before any files that use Sol
• Place this line at the top any files that use Sol: local Sol = LibStub("Sol")

Example

File stucture

• MyAddon/Libs/LibStub.lua
• MyAddon/Libs/Sol.lua
• MyAddon/MyAddon.toc
• MyAddon/MyAddon.lua
• MyAddon/MyAddon.xml

MyAddon.toc

• Libs/LibStub.lua
• Libs/Sol.lua
• MyAddon.lua
• MyAddon.xml

MyAddon.lua

• local Sol = LibStub("Sol")
• ...

Sol takes inspiration from many other libraries. Its name is a play on the WoW Sea and Sky addons. However, at the moment I'm the sole developer. There are undoubtedly things that I've done suboptimally and many areas for expansion and optimization. I welcome any and all help with testing, maintaining, and adding to Sol.