Skip to content

Commit a53724b

Browse files
committed
Update README
Refresh README layout and content: update badges and release version, add a prominent note about the community-maintained fork, reorganize and reword features for clarity, add Screenshots section, introduce a Configuration table and Command Palette entries, and update Credits. Formatting and ordering were improved for readability.
1 parent 359ab4b commit a53724b

1 file changed

Lines changed: 38 additions & 16 deletions

File tree

README.md

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,49 @@
11
# CfxLua IntelliSense (FiveM / RedM)
22

3-
[![Open VSX Registry](https://img.shields.io/open-vsx/v/anishbplayz/cfxlua-vscode-openvsx)](https://open-vsx.org/extension/anishbplayz/cfxlua-vscode-openvsx) [![Open VSX Downloads](https://img.shields.io/open-vsx/dt/anishbplayz/cfxlua-vscode-openvsx)](https://open-vsx.org/extension/anishbplayz/cfxlua-vscode-openvsx) [![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/anishbplayz.cfxlua-vscode-openvsx)](https://marketplace.visualstudio.com/items?itemName=anishbplayz.cfxlua-vscode-openvsx) [![VS Code Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/anishbplayz.cfxlua-vscode-openvsx)](https://marketplace.visualstudio.com/items?itemName=anishbplayz.cfxlua-vscode-openvsx)
3+
[![Version](https://img.shields.io/badge/version-1.10.16-blue)](https://github.com/AnishBplayz/cfxlua-vscode-openvsx/releases)
4+
[![Open VSX](https://img.shields.io/badge/Open_VSX-Registry-8732a0?logo=openvscode)](https://open-vsx.org/extension/anishbplayz/cfxlua-vscode-openvsx)
5+
[![VS Marketplace](https://img.shields.io/badge/VS_Marketplace-Install-007acc?logo=visualstudiocode)](https://marketplace.visualstudio.com/items?itemName=AnishBplayz.cfxlua-vscode-openvsx)
46

5-
**Source:** [AnishBplayz/cfxlua-vscode-openvsx](https://github.com/AnishBplayz/cfxlua-vscode-openvsx)
7+
> **Note**
8+
> Community-maintained fork of the archived [overextended/cfxlua-vscode](https://github.com/overextended/cfxlua-vscode). Published under the `anishbplayz` namespace on [Open VSX Registry](https://open-vsx.org/extension/anishbplayz/cfxlua-vscode-openvsx) and [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=AnishBplayz.cfxlua-vscode-openvsx).
9+
>
10+
> *This extension is not authored, published, sponsored, nor endorsed by Cfx.re.*
611
7-
> [!NOTE]
8-
> Community-maintained fork of archived [overextended/cfxlua-vscode](https://github.com/overextended/cfxlua-vscode). Published under the `anishbplayz` namespace on [Open VSX Registry](https://open-vsx.org/extension/anishbplayz/cfxlua-vscode-openvsx) and [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=anishbplayz.cfxlua-vscode-openvsx).
9-
10-
_This extension is not authored, published, sponsored, nor endorsed by Cfx.re._
12+
---
1113

1214
## Features
1315

14-
- Diagnostics, IntelliSense, annotations, and auto-completion provided by [sumneko's Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua).
15-
- Support for runtime/environment globals (e.g. CreateThread, promises, json, statebags).
16-
- Support for FiveM, RedM, and CFX natives.
17-
- Support for Cfx's implementation of the [Lua language (LuaGLM)](https://github.com/citizenfx/lua/tree/luaglm-dev/cfx).
18-
- Support for vector, quat, and matrix types.
19-
- Partial support for extended syntax / [power patches](https://github.com/citizenfx/lua/blob/luaglm-dev/cfx/README.md#power-patches).
20-
- _Use with caution, some patches have been known to cause crashes!_
16+
- **IntelliSense & diagnostics** — Provided by [sumneko's Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua): diagnostics, annotations, and auto-completion.
17+
- **Runtime globals** — Support for environment globals (e.g. `CreateThread`, promises, `json`, statebags).
18+
- **Natives** — Support for FiveM, RedM, and CFX natives.
19+
- **LuaGLM** — Support for Cfx's [Lua implementation (LuaGLM)](https://github.com/citizenfx/lua/tree/luaglm-dev/cfx):
20+
- Vector, quat, and matrix types.
21+
- Partial support for extended syntax / [power patches](https://github.com/citizenfx/lua/blob/luaglm-dev/cfx/README.md#power-patches).
22+
*Use with caution — some patches have been known to cause crashes.*
23+
24+
---
2125

22-
![image](https://github.com/user-attachments/assets/586b960c-3b1e-4911-80dd-788a0917b0f8)
23-
![image](https://github.com/user-attachments/assets/22bb5f61-9b4d-4461-98f3-0eaba196839b)
26+
## Screenshots
27+
28+
![IntelliSense preview](https://github.com/user-attachments/assets/586b960c-3b1e-4911-80dd-788a0917b0f8)
29+
30+
![Auto-completion preview](https://github.com/user-attachments/assets/22bb5f61-9b4d-4461-98f3-0eaba196839b)
2431

2532
---
2633

27-
**Thanks to CitizenFX, gottfriedleibniz, alloc8or, iTexZoz, TasoOneAsia and Overextended**
34+
## Configuration
35+
36+
| Setting | Options | Description |
37+
|----------------|-----------|--------------------------|
38+
| `cfxlua.game` | `gtav`, `rdr3` | Choose GTA V or RDR3 natives. |
39+
40+
**Commands (Command Palette):**
41+
42+
- **CfxLua: Use GTAV natives** — Switch to GTA V natives.
43+
- **CfxLua: Use RDR3 natives** — Switch to RDR3 (RedM) natives.
44+
45+
---
46+
47+
## Credits
48+
49+
Thanks to CitizenFX, gottfriedleibniz, alloc8or, iTexZoz, TasoOneAsia, Overextended and CommunityOX.

0 commit comments

Comments
 (0)