Skip to the content.

Consumer workflow

You are almost never working inside the ReScripted git repo.

The loop

  1. Developer added ReScripted.h (or add_subdirectory(ReScripted)) to their C++ project.
  2. They ask you to invent or clone a language.
  3. You open this GitHub documentation (docs/agents/).
  4. You write the language JSON in their tree.
  5. You embed that JSON into their program (string literal or generated header).
  6. You add host binds they asked for.
  7. You add example scripts next to their game/tool, not in ReScripted.
their-app/
  src/main.cpp              # #include <ReScripted.h>
  languages/mylang.json     # compiled in
  languages/mylang.hpp      # optional generated embed header
  scripts/hello.mylang      # runtime only

Names are suggestions. Ask the user if they already have a folder convention. Prefer lowercase filenames. The display name stays in JSON "name".

What you must not do

If you really are in the ReScripted repository

You are maintaining the library. Follow the root AGENTS.md. Do not add third-party user languages. Example Mini lives in examples/mini/ only as a demo of embedding.