learn-lua

Note: This is a very basic lua tutorial to get you familiar with NvChad config

Printing

  1. print("Hi")

Comments

  1. -- A comment
  2. print("Hi") -- another comment

Variables

  1. -- Different types
  2. local x = 10 -- number
  3. local name = "Sid" -- string
  4. local isAlive = true -- boolean
  5. local a = nil --no value or invalid value

Numbers

  1. -- Examples
  2. local a = 1
  3. local b = 2
  5. print(a + b) -- 3
  1. -- increment
  2. local level = 1
  3. level = level + 1
  4. print(level) -- 2

Strings

  1. -- Concatenate strings
  2. local phrase = "I am"
  3. local name = "Sid"
  4. print(phrase .. " " .. name) -- I am Sid
  6. -- Strings and numbers
  7. local name = "NvChad"
  8. print(name .. " v" .. 1.0) -- NvChad v1.0

Boolean

  1. local isAlive = true
  2. print(isAlive) -- true
  4. isAlive = false
  5. print(isAlive) -- false

Comparison Operators

  • \== equality
  • < less than
  • > greater than
  • <= less than or equal to
  • >\= greater than or equal to
  • ~= inequality

Conditional Statements

  1. -- Number comparisons
  2. local age = 10
  4. if age > 18 then
  5.   print("over 18") -- this will not be executed
  6. end
  8. -- elseif and else
  9. age = 20
  11. if age > 18 then
  12.   print("over 18")
  13. elseif age == 18 then
  14.   print("18 huh")
  15. else
  16.   print("kiddo")
  17. end
  1. -- Boolean comparison
  2. local isAlive = true
  4. if isAlive then
  5.     print("Be grateful!")
  6. end
  8. -- String comparisons
  9. local name = "sid"
  11. if name ~= "sid" then
  12.   print("not sid")
  13. end

Combining Statements

  1. local age = 22
  3. if age == 10 and x > 0 then -- both should be true
  4.   print("kiddo!")
  5. elseif x == 18 or x > 18 then -- 1 or more are true
  6.   print("over 18")
  7. end
  9. -- result: over 18

Invert Value

you can also invert a value with the not keyword

  1. local x = 18
  3. if not x == 18 then
  4.   print("kiddo!")
  5. end

Functions

  1. function num(a)
  2.   print(a)
  3. end
  5. or
  7. local num = function(a)
  8.   print(a)
  9. end
  11. num(5)
  13. -- result : 5
  1. -- multiple parameters
  3. function sum(a, b)
  4.   local result = a + b
  5.   print(result)
  6. end

Scope

Variables have different scopes. Once the end of the scope is reached the values in that scope are no longer accessable

  1. function foo()
  2.   local n = 10
  3. end
  5. print(n) -- nil , n isn't accessible outside foo()

Loops

Different ways to make a loop

  1. -- while loop
  2. local i = 0
  4. while i <= 3 do
  5.    print("hi")
  6.    i = i + 1
  7. end
  9. OR
  11. -- for loop
  12. for i = 0, 3 do
  13.    print("hi")
  14.    i = i + 1
  15. end
  17. -- result
  18. hi
  19. hi
  20. hi

Tables

  1. -- Basic table
  2. local colors = { "red", "green", "blue" }
  4. print(colors[1]) -- red
  5. print(colors[2]) -- green
  6. print(colors[3]) -- blue
  8. -- Use a loop to iterate though the table
  9. for i = 1, #colors do
  10.   print(colors[i])
  11. end

Two Dimensional Table

  1. -- Tables within tables
  2. local data = {
  3.     { "billy", 12 },
  4.     { "john", 20 },
  5. }
  7. for i = 1, #data do
  8.   print(data[i][1] .. " is " .. data[i][2] .. " years old")
  9. end

Modules

Include code from other files

  1. require("otherfile")
  • Credits - Modified version of this guide