Code layout

Tabs or Spaces?

Use tabs only. Never mix tabs and spaces.

Maximum Line Length

Limit all lines to a maximum of 79 characters.

Blank Lines

Separate top-level function and class definitions with a single blank line.

Use a single blank line within the bodies of methods or functions in cases where this improves readability.

Trailing Whitespace

Do not include trailing whitespace on any lines.

Encoding

UTF-8 is the preferred source file encoding.

Whitespace in Functions and Operators

Avoid extraneous whitespace in the following situations:

Immediately inside parentheses, brackets or braces

 print('argument') -- Yes
 print( 'argument' ) -- No

Immediately before a comma
```
 print(x, y) -- Yes
 print(x , y) -- No
```
Always surround these binary operators with a single space on either side
- assignment: =
- comparisons: ==, <, >, <=, >=, !=, ~= etc.
- arithmetic operators: +, -, *, /, etc.
- (Do not use more than one space around these operators)
```
 -- Yes
 x = 1
 y = 1
 steamID = 3

 -- No
 x      	= 1
 y      	= 1
 steamID = 3
```

Naming Conventions

Use camelCase (with a leading lowercase character) to name all local variables.

Use CamelCase (with a leading uppercase character) to name all global variables, fields and methods.

For enums, use all uppercase with underscores: ENUM_LIKE_THIS.

Comments

The first word of the comment should be capitalized, unless the first word is an identifier that begins with a lower-case letter. If a comment is short, the period at the end can be omitted.

Block Comments

Block comments apply to the block of code that follows them.

Paragraphs inside of block comments are separated by a single line.

--[[
	Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
	tempor incididunt ut labore et dolore magna aliqua.

	Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
	tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
	quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
	consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
	cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
	proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
]]

Init()
Start()
Stop()

Inline Comments

All inline comments should start with a -- and a single space.

The use of inline comments should be limited, because their existence is typically a sign of a code smell.

x = x + 1 -- One second prediction

Strings

Prefer single quoted strings ('') instead of double quoted ("") strings, unless features like string interpolation are being used for the given string.

Miscellaneous

and is preferred over &&.

or is preferred over ||.

not is preferred over !.

!= is preferred over ~=.

Capster / lua-style-guide