Skip to content

Narrator (AI) ​

Plugin ID: cn.hayashiume.narratorConfig file: [Empostor.Plugin.Narrator]Config.json

ReferenceWhere
ConfigurationConfig.json
Commands#narrator
Admin PanelNarrator tab
HTTP APINone

Third-party API

Responses come from the DeepSeek AI API. You supply your own API key and are responsible for its usage and cost. The plugin sends game context (roles, tasks, deaths, chat, votes) to that endpoint.

Commands ​

CommandAliasesUsagePermission
#narrator <question>#nar, #nAsk for strategic adviceEveryone
#narrator enable—Enable the narrator for this gameHost
#narrator disable—Disable the narrator for this gameHost
#narrator status—Show current narrator statusHost
#narrator limit <N>—Set the per-game usage limitHost
#narrator
#nar What should I do?

The response is delivered as a private message to the requesting player.

Configuration ​

Edit [Empostor.Plugin.Narrator]Config.json next to the plugin DLL.

json
{
  "apiKey": "",
  "model": "deepseek-v4-flash",
  "apiEndpoint": "https://api.deepseek.com/",
  "maxUsesPerGame": 3,
  "maxUsesPerMeeting": 1
}
FieldTypeDefaultDescription
apiKeystring""DeepSeek API key. Required — narration silently fails without it.
modelstring"deepseek-v4-flash"Model ID sent to the API.
apiEndpointstring"https://api.deepseek.com/"Base URL of the API. Change it to use a compatible provider.
maxUsesPerGameint3Maximum narrator calls per player per game.
maxUsesPerMeetingint1Maximum narrator calls per player per meeting.

Before first use

Set apiKey before relying on #narrator. All other fields have working defaults.

Admin Panel ​

Narrator tab: API Key (masked), Model Name, API Endpoint, Max Uses Per Game, Max Uses Per Meeting. Changes are written to the config file.

  • Commands — full list of in-game commands.