CodexCount

CodexCount

Addons
3 Downloads

CodexCount

Counts the number of Cataloged Research currently in your bag, so you know how much reputation you will gain with The Archivists' Codex faction.

image

Development

Environment

Recommended development environment is VS Code with the following extensions:

  • fsdeploy - auto-deploy addon locally on file change (configured for a standard Windows C:\\Program Files (x86)\\World of Warcraft install location)
  • WoW API - intellisense for WoW APIs
  • Lua language server - included with WoW API above
  • vscode-lua - for linting + formatting

The Luacheck static analyzer should be installed locally and configured as lua.luacheckPath in the vscode-lua settings.

Style

This project uses 2-space indentation and the vscode-lua formatter. The workspace settings have been configured to use this by default; if you have the above extensions installed your code will be autoformatted on save or when the editor loses focus. Otherwise we use the following conventions:

-- variables first
local CONSTANTS_ALL_CAPS_SNAKE_CASE = true
local lowerCamelCaseFileLocal = 1
GlobalUpperCamelCase = {}

-- functions last
local function LocalFunctionUpperCamelCase() 
  if (useBracketsPlease) then end
end

function SomeVar:GlobalFunctionUpperCamelCase()
  local lowerCamelCaseFunctionLocal = nil
end