@@ -6,12 +6,14 @@ This repository contains EmmyLua annotations for ScheduleLua modding, providing
66
77## Installation
88
9- ### Prerequisites
9+ ### Method 1: Manual Installation
10+
11+ #### Prerequisites
1012
1113- [ Visual Studio Code] ( https://code.visualstudio.com/ )
1214- [ Lua Language Server] ( https://marketplace.visualstudio.com/items?itemName=sumneko.lua ) extension by sumneko
1315
14- ### Steps to Install
16+ #### Steps to Install
1517
16181 . ** Install the Lua Language Server extension** :
1719 - Open VSCode
@@ -24,31 +26,47 @@ This repository contains EmmyLua annotations for ScheduleLua modding, providing
2426 - Copy the ` libs ` folder to your mod project directory
2527 - Add the provided ` .luarc.json ` file to your mod project root directory
2628
29+ ### Method 2: VSIX Extension Installation
30+
31+ 1 . ** Install the ScheduleLua Extension** :
32+ - Download the provided ` .vsix ` file
33+ - Open VSCode
34+ - Go to Extensions (Ctrl+Shift+X)
35+ - Click the "..." menu in the top-right of the Extensions panel
36+ - Select "Install from VSIX..."
37+ - Choose the downloaded ` .vsix ` file
38+
39+ 2 . ** Using the Extension Commands** :
40+ The extension provides three convenient VSCode commands:
41+ - ` ScheduleLua: Setup Workspace for Mod Development ` - Automatically configures your workspace with ScheduleLua annotations
42+ - ` ScheduleLua: Create New Mod Template ` - Creates a new mod project with the basic structure
43+ - ` ScheduleLua: Show API Documentation ` - Opens the ScheduleLua API documentation website
44+
2745### Verifying Installation
2846
29471 . Open your mod project in VSCode
30482 . Create or open a Lua file
31493 . Try referencing a ScheduleLua API function (e.g., ` RegisterCommand ` )
32504 . You should see intellisense suggestions and documentation pop up
3351
34- ## Usage
35-
36- With this setup, you'll get the following benefits when working on ScheduleLua mods:
37-
38- - Code completion for ScheduleLua API functions
39- - Function parameter hints
40- - Documentation on hover
41- - Type checking
42- - Navigation to definition
43-
4452## Deployment
4553
4654When deploying your mod for others to use:
4755
48- 1 . ** Do not include** the ` libs ` folder and ` .luarc.json ` file in your final mod distribution
56+ 1 . ** Do not include** the ` libs ` or ` .vscode ` folders, and ` .luarc.json ` file in your final mod distribution
49572 . These files are development tools only and not required for your mod to function
50583 . Only include your actual mod files (scripts, assets, etc.) in the distribution
5159
60+ ## Best Practice
61+
62+ When using the VSCode annotations, follow this guide for the best/easiest route:
63+
64+ 1 . Install the ` .vsix ` extension from releases
65+ 2 . Create a development folder somewhere (e.g. Desktop) and name it something like ` Lua Mods `
66+ 3 . Open the newly created folder in VSCode
67+ 4 . Run the ` ScheduleLua: Setup Workspace for Mod Development ` command to setup your new folder for ScheduleLua development.
68+ 5 . Now whenever you want to make a mod, run the ` ScheduleLua: Create New Mod Template ` command in your newly setup workspace/folder.
69+
5270## Troubleshooting
5371
5472If intellisense is not working:
0 commit comments