PICO-8 EmmyLua autocomplete definitions
EmmyLua definitions for the PICO-8 API, for autocomplete/intellisense support in code editors where integration with the EmmyLua Language Server is supported (IntelliJ , VSCode).
Using
Prerequisites
You must have an integration with the EmmyLua Language Server set up in your editor. EmmyLua has first-class support for IntelliJ and VSCode, with other setups supported through some configuration. See the section below for suggestions if you are using VSCode.
Installation
Simply place the file pico8.lua somewhere in your workspace, I would recommend a folder called _pico8 or _api or something. You may have to change some settings to reference these definitions as a library, but in my experience simply having them in your workspace is enough.
One approach that also makes it easy to update would be to simply clone this repo into your project's directory:
git clone [email protected]:peabnuts123/pico8-emmylua-definitions.git _pico8That way you can run git pull if you need to update the definitions. You will have to copy the files manually if you intend to commit them to your project, however.
Visual Studio Code
If you are using VSCode, I would recommend this extension, which integrates with the EmmyLua language server as well as providing many Lua code editing features such as Go To Definition, linting and more.
Contributing
Please let me know if there are any incorrect or missing definitions by opening an issue or submitting a pull request.
Future work
Some future work I am considering:
- Automating the generation of these definitions from the PICO-8 Fandom Wiki (where most of these definitions came from)
- Changing the variable names and documentation to be more clear (i.e. author my own documentation)
- Creating a version for each version of PICO-8, managed through git tags