Setup IntelliSense

Lua IntelliSense definitions (.d.lua) for GrowSoft / GTPS Cloud LuaScript.

This guide explains how to enable autocomplete, type hints, callback signatures, and hover documentation in Visual Studio Code using Lua Language Server (sumneko).

WARNING

⚠️ This project provides IntelliSense stubs only The files are NOT executed at runtime.

🔗 Official source repository:
https://github.com/nperma/luascript-growsoft

---

📁 Project Structure

luascript-growsoft/
│
├─ api/
│  └─ growsoft.d.lua   # Main IntelliSense definitions
│
├─ scripts/            # Public folder
│  └─ premium/         # Private folder
│
└─ .vscode/
└─ settings.json

Only one IntelliSense file is required:

👉 api/growsoft.d.lua

⬇ Download ZIP🌐 View on GitHub

---

🚀 Installation (VS Code)

1️⃣ Install Lua Language Server

1. Open Visual Studio Code
2. Go to Extensions
3. Install Lua Language Server (by sumneko)

---

2️⃣ Clone or Copy the Repository

You may place this repository anywhere on your system:

C:/Documents/luascript-growsoft/

Or clone it directly:

git clone https://github.com/nperma/luascript-growsoft

---

3️⃣ Configure .vscode/settings.json

To make Lua Language Server load the .d.lua IntelliSense file, add the following configuration:

{
  "Lua.workspace.library": ["./api"]
}

WARNING

Make sure the api folder is included in Lua.workspace.library.

---

✨ Features

With this setup, you will get:

• GrowSoft API autocomplete
• Type hints for Player, World, Tile, etc.
• Callback signature help
• Hover documentation
• Early error detection

---

INFO

🚧 This IntelliSense is NOT complete yet

• Some APIs may be missing
• Some callback parameters may be undocumented
• Types may change following server updates

This project aims to match real GrowSoft / GTPS Cloud behavior as closely as possible, but it is still work in progress.

---

🤝 Contributing

Contributions are very welcome ❤️

You can help by:

• Adding missing APIs
• Fixing incorrect type definitions
• Improving documentation comments
• Syncing with GrowSoft / GTPS Cloud updates

---

📜 License

Provided as-is for development convenience. No official affiliation with GrowSoft or GTPS Cloud.

---

⭐ If this project helps you, consider giving it a star on GitHub.