Open Visual Studio Code and select Extensions from the left bar
At the top of Extensions menu click on three dots and select "Install From VSIX..."
In the Install from VSIX window select downloaded .vsix file
Restart Visual Studio Code
Optionally you can change the targetted engine in File/Preferences/Settings/Extensions/Funkin Script AutoComplete/Lua Engine
Quick Documentation
Code Comments
Enable this extension in a file: ---@funkinScript (only if funkinscriptautocomplete.enableOnlyOnCertainScripts setting is on)
Set FNF engine for this file: ---@funkinEngine={psych|pengine|etc.}
Disable deprecated warnings for specific function on this file: ---@diagnostic disable: {funcs}
Disable deprecated warnings for specific function on next line: ---@diagnostic disable-next-line: {funcs}
Report bugs and contribute to this extension on Github
Contributing
Any pull requests are appreciated, feel free to Pull Request any missing engines, functions or variables!
If you want to add another engine to this extension make a json file in src/ called something like "piss-engine_data.json", this data file should be based of any *_data.json file
NOTE : If you don't know how to install dependencies use npm install
Adding a engine
Creating a data file from a engine's lua class URL
Open art/updateEngineData.py
Add case "yourEngineName": at the end of match Data.engine_name: in selectEngine()
Follow the pattern of previous cases
Run python art/updateEngineData.py in current repo's directory and enter yourEngineName there
This will create a data file in src/yourEngineName_data.json
If the data file is empty or lacks functions / variables or the function names are corrupted you can: A) Add support for engine in updateEngineData.py B) Add everything manually
Update existing engine data
If art/updateEngineData.py has support for some engine then:
Run python art/updateEngineData.py in current repo's directory and enter the name of engine there
You should manually add/change documentation value (if documentation is "Needs documentation" or doesn't exist) and a returns value (if returns is "???" or doesn't exist)
If a function is deprecated add "deprecated": "deprecated message here" to the function
