Skip to content

AGENTS.md for AI coding assistants

Many people write game scripts with an AI coding assistant. An assistant that does not know Bornescript guesses: it writes JavaScript, calls functions that do not exist, and trusts what a client sends. AGENTS.md is one file that fixes that. It holds the rules of the language, the authoring conventions, the limits, the behaviors that may still change, and a list of every built-in function.

Download AGENTS.md

File size 141.8 KiB. For engine version 0.1.0.

What is in the file

  1. What you are writing
  2. The language in one page
  3. Events and timers
  4. Authoring conventions
  5. Server and client
  6. Limits and the sandbox
  7. Provisional behaviors
  8. Common mistakes
  9. API digest
  10. How to check a script
  11. Older GS2 scripts
  1. Download the file.
  2. Put it in the root of your script project, next to the weapons, npcs, and classes folders. Most coding assistants read a file named AGENTS.md there before they work.
  3. Ask the assistant to write or change a script, and read what it writes before you upload it. Check a script with the editor of the RC tool, or in the playground when it needs no world.
  • It is generated from the same sources as this documentation: the language reference, the definitions of every built-in, and the list of open questions. It is updated with each engine version, so download it again after an update.
  • It is written for a reader with no memory of the engine: short rules, no history.
  • It is not a replacement for the language reference and the API reference. The file links to both.

Engine version 0.1.0. Built 2026-11-18.