When making a plugin for the rhythm game Quaver, many globals go unnoticed or unused, with no autocomplete for editor interaction or imgui structuring. The purpose of quinsight, built by myself and Emik, is to provide plugin developers with well-documented intellisense and properly-labeled classes.
Either use this repository as a submodule, or simply clone the intellisense.lua file into your own project. Your intelligent IDE (in my case, Visual Studio Code) should pick up on the defined globals and types for autocompletion and type-checking purposes.
- Supports the
HitObject,TimingPoint,ScrollVelocity,ScrollSpeedFactor, andScrollGrouptypes as LuaLS classes. - Supports explicitly working with
VectorNas its own type. - Includes all properties and methods of the
map,state,actions, andutilglobals. - Includes all
imguifunctions, documented with LuaLS. - Includes all Quaver provided enums, including
action_type,keys, andhitsounds.
- Emik, for support with imgui functions and documentation.
- IceDynamix, for creating the original version of intellisense that this was based off of, QuaverPluginIntellisense.
it's pronounced quin-sight. two meanings: 1) quinsight = quaver insight, 2) quin = 5, and the 5 things to sight are hitobjects, timing lines, scroll velocities, scroll speed factors, and scroll groups.