Neovim.

Scripts inside the Neovim editor, as an ordinary plugin.

This page is generated from the SDK's platform registry (sdk/environments.json) and the adapter's SETUP.md. The Neovim page on the site is the short version.

How it runs

An ordinary Neovim plugin. setup() starts the core in Neovim's LuaJIT, a libuv timer ticks it on the main loop, and :ScriptGo <command> runs resource commands. Server and local client run in the editor.

The adapter's code and README: sdk/adapters/neovim.

Set up

Needs Neovim 0.10 or later (measured on 0.12.6) and curl for licensed packages.

1. Add sdk/adapters/neovim/ to Neovim as a plugin. Inside the SDK checkout it finds the core by itself; elsewhere copy sdk/lua/scriptgo/ to lua/scriptgo_nvim/core/ in the plugin, or set vim.g.scriptgo_core. With lazy.nvim:

   luaCopy

   {
     dir = "~/scriptgo/sdk/adapters/neovim",
     config = function()
       require("scriptgo_nvim").setup({
         search = { vim.fn.expand("~/scriptgo/resources") },
         resources = { "sg_inventory" },
         config = { permissions = { ["1"] = { "*" } } },
       })
     end,
   }

2. Use it from the editor:

   vimCopy

   :ScriptGo status
   :ScriptGo giveitem 1 water 2
   :ScriptGo log

The server side and the local client (you, player 1) run inside the editor, ticked by a timer on the main loop. Notifications go to vim.notify; storage to stdpath("data")/scriptgo/storage.

Capabilities

What the adapter provides. See SDK and capabilities for what each one is.

Protection

Licence check and signed releases. The host runs plain script, so its operator can read what it loads: no code-secrecy claim.

See Protect your work for what protection does and does not do.

Assets

Maps, models, textures, sounds and other files players download. See Selling assets.

No game client downloads anything: assets are files of the resource.

Asset escrow: The host can read containers itself, but its operator holds the key: at-rest encryption only.

Limits

• Single user: no real network between server and client.
• HTTP, and so online license checks, needs curl and Neovim 0.10 or later.
• Measured with Neovim 0.12.6 (LuaJIT 2.1) on Windows, headless (nvim --headless --clean -l); macOS, Linux and older Neovim releases are not measured yet.

Real runs

Each row is a scriptgo verify run on Neovim itself, not on a mock or an emulator: the package started there and its own tests reported back. Rows marked probe are SCRIPT//GO's conformance probes, which exercise the runtime and are never published as packages. See how a status is earned.