home/roleplay/lua-instructions

Lua.instructions

GPTClaudeGemini··▲ 570 copies·updated 2026-07-14

lua-instructions.prompt

# GitHub Copilot Instructions

These instructions define how GitHub Copilot should assist with this project. The goal is to ensure consistent, high-quality code generation aligned with our conventions, stack, and best practices.

## 🧠 Context

- **Project Type**: Game Script / CLI Tool / Plugin / Embedded Config
- **Language**: Lua
- **Framework / Libraries**: LÖVE / Neovim / OpenResty / LuaSocket / Busted
- **Architecture**: Modular / Event-Driven / Data-Driven

## 🔧 General Guidelines

- Use idiomatic Lua conventions (e.g., snake_case for variables, PascalCase for modules).
- Prefer local variables and encapsulate state in tables or closures.
- Keep functions short and focused.
- Avoid deeply nested logic and long procedural files.
- Use metatables only when necessary and document their behavior.
- Format consistently (e.g., stylua or lua-fmt).
- Prefer readability over cleverness or optimization.

## 📁 File Structure

Use this structure as a guide when creating or updating files:

when to use it

Community prompt sourced from the open-source GitHub repo Code-and-Sorts/awesome-copilot-agents (CC0-1.0). A "Lua.instructions" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.