README.md

autopilot.lua

Full code completion for pilot.lua using JohnnyMorganz' Luau Language Server.

Warning

This repository is being discontinued (for the time being) in favor of Arvid's pilot.lua types for luau-lsp. Features include:

• In-editor descriptions for objects, methods, configurables and events.
• Strict typechecking for Configure and configurables in general.
• Parameter names for event connections
• ArvidSilverlock

Make sure to star their repository if you find it helpful.

Getting Started

To get started, follow these simple steps:

1. Download the Definitions File:

   • Head over to the Releases tab.
   • Download the latest version of the pilot.d.lua file.

2. Install luau-lsp for VSCode:

   • Install JohnnyMorganz's luau-lsp extension for Visual Studio Code. (Marketplace link)

3. Create Your Project Folder:

   • Create a folder to put your Waste of Space Project(s), then right click it and Open With Code

   • Place pilot.d.lua in your folder.

   • Create a .vscode folder in your project directory.

   • Inside the .vscode folder, create a settings.json file and paste the following code:

     {
       "luau-lsp.sourcemap.enabled": false,
       "luau-lsp.types.roblox": true,
       "luau-lsp.types.definitionFiles": ["./pilot.d.lua"]
     }

   • Reload the window for the definitions to load. (CTRL+Shift+P -> Reload Window)

4. Enjoy Full Code Completion:

   • With the setup complete, you now have full code completion for pilot.lua in Visual Studio Code.
   • You must have the folder open for autocomplete to work. Opening individual files does not work.

Build Steps

If you want to build autopilot.lua from scratch, follow the steps below:

1. Clone the Repository

   • Clone the repository to your local machine

     git clone https://github.com/flxwed/autopilot.lua.git
     

2. Generate Definitions via Script

   • Open your cloned repository in your favorite code editor

   • Run scripts/generateDefinitions.py and pass the project directory as the first argument.

   • After the script finishes, the generated code can be found at build/pilot.d.lua.

     py scripts/generateDefinitions.py .
     > .\build\pilot.d.lua created successfully
     cat build/pilot.d.lua
     > type PortLike = number | {GUID: string}
       type Properties = {[string]: any}
       ...
     

Contributions

We welcome contributions and bug reports. Feel free to fork the repository, make your changes, and submit a pull request. If you encounter any issues or have suggestions for improvement, please open an issue.

If you are having issues with setup, feel free to DM me before opening an issue. (@3nfg)