Installation:

1. Make the BuildAndRun.sh script executable if it isn't already:

   chmod +x BuildAndRun.sh

2. If you've installed the Playdate SDK to the default path (Documents folder), then just run setup.sh to add environment variables:

   • PLAYDATE_SDK_PATH to Playdate SDK
   • Adds Playdate SDK's bin folder to PATH (if it is not already added) to create pdc shortcut

   !!! If you've changed the default path, edit the appropriate section in setup.sh to set your custom SDK path, then run it.

   SDKPATH="/path/to/your/custom/sdk"

   This should be done only once. You need to restart VSCode after this.

3. Open the template folder with VSCode, install the recommended extensions (a popup will show in the lower right corner): Lua, Lua Plus. Then restart VSCode.

4. If you want to change the "build and run" key (default is Ctrl+Shift+B):

   • Cmd + K, Cmd + S
   • Change the keybind for Tasks: Run Build Task (You can change it to another key, for example, F5).

5. You can find your main.lua file inside the source folder. Press your "Run Build Task" button, and you should see the "Template" text in the Playdate simulator.

6. Feel free to delete dvd.lua and all DVD-related lines from main.lua (marked -- DEMOO).

7. ⚠️ Don't forget to change your unique project info in source/pdxinfo: "bundleID", "name", "author", "description". Read more about pdxinfo here.

It's critical to change your game bundleID, so there will be no collisions with other games, installed via sideload.

Using setup.sh

The setup.sh script is designed to help you set up your environment for the Playdate SDK. It can be run with various flags to customize its behavior.

Available Flags:

• -a: Update all configurations. This includes updating the $PATH, config, and startup.sh. This flag expects the path to the SDK as its argument.

  Example: ./setup.sh -a /path/to/PlaydateSDK

• -p: Update only the $PATH variable to include the Playdate SDK's bin directory. This flag expects the path to the SDK as its argument.

  Example: ./setup.sh -p /path/to/PlaydateSDK

• -c: Update only the config file with the provided SDK path. This flag expects the path to the SDK as its argument.

  Example: ./setup.sh -c /path/to/PlaydateSDK

• -s: Update only the startup.sh file with the provided SDK path. This flag expects the path to the SDK as its argument.

  Example: ./setup.sh -s /path/to/PlaydateSDK

• -t: Test mode (Dry run). This will show the changes that would be made without actually applying them. This flag expects the path to the SDK as its argument.

  Example: ./setup.sh -t /path/to/PlaydateSDK

Notes:

• If no flags are provided, the script will present a menu to guide you through the setup process.
• It's essential to provide the correct path to the Playdate SDK when using the flags.
• After running the script, you might need to restart your terminal or VSCode for the changes to take effect.