Skip to content

Commit 7948d14

Browse files
committed
docs(contributing): update .luarc.json docs for gitignored setup
The .luarc.json is now gitignored (not committed), so update the contributing guide to reflect that developers must copy the example config locally instead of editing a committed file. Also document that SMODS scanning .json mod directories produces a harmless log error, and add the Balatro globals (localize, get_blind_amount, get_compressed, save_run, compress_and_save) that were recently removed from inline diagnostic suppressions.
1 parent 7f174af commit 7948d14

1 file changed

Lines changed: 18 additions & 7 deletions

File tree

docs/contributing.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,21 @@ export BALATROBOT_PATH_LOVELY='/path/to/liblovely.dylib'
4343

4444
### Lua LSP Configuration
4545

46-
The `.luarc.json` file should be placed at the root of the balatrobot repository. It configures the Lua Language Server for IDE support (autocomplete, diagnostics, type checking).
46+
The `.luarc.json` file at the project root configures the Lua Language Server for IDE support (autocomplete, diagnostics, type checking).
4747

48-
!!! info "Update Library Paths"
48+
!!! info "Gitignored — copy from template"
4949

50-
You **must** update the `workspace.library` paths in `.luarc.json` to match your system:
50+
`.luarc.json` is **gitignored** and not committed to the repo. Copy the example below to create your own, or check the current version in the CI logs / ask a maintainer.
5151

52-
- Steamodded LSP definitions: `path/to/Mods/smods/lsp_def`
53-
- Love2D library: `path/to/love2d/library` (clone locally: [LuaCATS/love2d](https://github.com/LuaCATS/love2d))
54-
- LuaSocket library: `path/to/luasocket/library` (clone locally: [LuaCATS/luasocket](https://github.com/LuaCATS/luasocket))
52+
SMODS scans all `.json` files in mod directories and will log a harmless error for `.luarc.json` — this is expected and does not affect mod loading.
53+
54+
!!! info "Library Paths"
55+
56+
You **must** update the `workspace.library` paths to match your system:
57+
58+
- **Steamodded LSP definitions:** `/path/to/Balatro/Mods/smods/lsp_def`.
59+
- **Love2D library:** `/path/to/love2d/library` (clone locally: [LuaCATS/love2d](https://github.com/LuaCATS/love2d))
60+
- **LuaSocket library:** `/path/to/luasocket/library` (clone locally: [LuaCATS/luasocket](https://github.com/LuaCATS/luasocket))
5561

5662
**Example `.luarc.json`:**
5763

@@ -74,7 +80,12 @@ The `.luarc.json` file should be placed at the root of the balatrobot repository
7480
"G",
7581
"BB_GAMESTATE",
7682
"BB_ERROR_NAMES",
77-
"BB_ENDPOINTS"
83+
"BB_ENDPOINTS",
84+
"localize",
85+
"get_blind_amount",
86+
"get_compressed",
87+
"save_run",
88+
"compress_and_save"
7889
]
7990
},
8091
"type": {

0 commit comments

Comments
 (0)