Files
browser/plugins/examples/scum-server-plugin/manifest.json
T
2026-07-20 16:42:33 +08:00

855 lines
24 KiB
JSON

{
"$schema": "../../manifests/game-plugin.manifest.schema.json",
"id": "game.scum",
"name": "SCUM Server",
"description": "First-party SCUM game server operations plugin with platform-mediated lifecycle and companion bridge support.",
"version": "0.1.0",
"kind": "game-plugin",
"tags": [
"scum",
"survival",
"dedicated-server",
"game-operations",
"companion-client"
],
"server": {
"type": "scum",
"displayName": "SCUM Dedicated Server",
"supportedOS": [
"windows",
"linux"
],
"createFormSchema": "schemas/create-form.schema.json"
},
"capabilities": [
"process.install",
"process.start",
"process.stop",
"process.restart",
"process.status",
"files.list",
"files.read",
"files.patch",
"logs.read",
"remote.ftp.read",
"remote.ftp.write",
"remote.rsync.read",
"remote.rsync.write",
"remote.run.files.read",
"remote.run.files.write",
"remote.run.process.start",
"remote.run.process.stop",
"remote.run.db.mysql.query",
"remote.run.db.sqlite.query",
"remote.run.logs.transfer",
"remote.run.rcon.command",
"client-manager.deploy",
"client-manager.control",
"client-manager.update",
"client-manager.rollback",
"client-manager.uninstall",
"artifacts.read",
"artifacts.write",
"ai.invoke"
],
"remoteAccess": {
"methods": [
"ftp",
"rsync",
"run"
],
"runCapabilities": [
"remote.run.files.read",
"remote.run.files.write",
"remote.run.process.start",
"remote.run.process.stop",
"remote.run.db.mysql.query",
"remote.run.db.sqlite.query",
"remote.run.logs.transfer",
"remote.run.rcon.command"
],
"databaseEngines": [
"mysql",
"sqlite"
],
"rcon": true,
"logTransfer": true
},
"bridge": {
"actions": [
"server.instances.read",
"jobs.dispatch",
"logs.query",
"artifacts.open",
"files.request",
"remote.access.request",
"ai.invoke",
"run.distribution.request",
"dependencies.request",
"logs.backfill.request",
"client-manager.request",
"plugin-lifecycle.request"
]
},
"gameClientBridge": {
"commands": [
{
"type": "announcement.send",
"title": "Send SCUM announcement",
"permission": "server.game-client.command",
"approvalLevel": "operator",
"payloadSchemaRef": "schemas/bridge/announcement.payload.schema.json",
"resultSchemaRef": "schemas/bridge/announcement.result.schema.json",
"timeoutSeconds": 60,
"maxPayloadBytes": 4096
},
{
"type": "companion.diagnostics",
"title": "Collect companion diagnostics",
"permission": "server.game-client.read",
"approvalLevel": "none",
"payloadSchemaRef": "schemas/bridge/diagnostics.payload.schema.json",
"resultSchemaRef": "schemas/bridge/diagnostics.result.schema.json",
"timeoutSeconds": 30,
"maxPayloadBytes": 2048
},
{
"type": "player.lookup",
"title": "Look up SCUM player",
"permission": "server.game-client.read",
"approvalLevel": "none",
"payloadSchemaRef": "schemas/bridge/player-lookup.payload.schema.json",
"resultSchemaRef": "schemas/bridge/player-lookup.result.schema.json",
"timeoutSeconds": 30,
"maxPayloadBytes": 4096
},
{
"type": "reward.deliver",
"title": "Deliver SCUM reward",
"permission": "server.game-client.command",
"approvalLevel": "operator",
"payloadSchemaRef": "schemas/bridge/reward-deliver.payload.schema.json",
"resultSchemaRef": "schemas/bridge/reward-deliver.result.schema.json",
"timeoutSeconds": 60,
"maxPayloadBytes": 4096
},
{
"type": "event.start",
"title": "Start SCUM event",
"permission": "server.game-client.command",
"approvalLevel": "operator",
"payloadSchemaRef": "schemas/bridge/event-start.payload.schema.json",
"resultSchemaRef": "schemas/bridge/event-start.result.schema.json",
"timeoutSeconds": 60,
"maxPayloadBytes": 4096
},
{
"type": "restart.prepare",
"title": "Prepare SCUM restart",
"permission": "server.game-client.maintenance",
"approvalLevel": "operator",
"payloadSchemaRef": "schemas/bridge/restart-prepare.payload.schema.json",
"resultSchemaRef": "schemas/bridge/restart-prepare.result.schema.json",
"timeoutSeconds": 120,
"maxPayloadBytes": 4096
},
{
"type": "maintenance.prepare",
"title": "Prepare SCUM maintenance",
"permission": "server.game-client.maintenance",
"approvalLevel": "platform-admin",
"payloadSchemaRef": "schemas/bridge/maintenance-prepare.payload.schema.json",
"resultSchemaRef": "schemas/bridge/maintenance-prepare.result.schema.json",
"timeoutSeconds": 120,
"maxPayloadBytes": 4096
}
],
"snapshots": [
{
"type": "companion.health",
"schemaVersion": "1",
"schemaRef": "schemas/bridge/companion-health.snapshot.schema.json",
"keepForSeconds": 604800,
"maxRecords": 1000
},
{
"type": "online.sessions",
"schemaVersion": "1",
"schemaRef": "schemas/bridge/online-sessions.snapshot.schema.json",
"keepForSeconds": 86400,
"maxRecords": 1000
},
{
"type": "players",
"schemaVersion": "1",
"schemaRef": "schemas/bridge/players.snapshot.schema.json",
"keepForSeconds": 86400,
"maxRecords": 1000
},
{
"type": "squads",
"schemaVersion": "1",
"schemaRef": "schemas/bridge/squads.snapshot.schema.json",
"keepForSeconds": 86400,
"maxRecords": 1000
},
{
"type": "vehicles",
"schemaVersion": "1",
"schemaRef": "schemas/bridge/vehicles.snapshot.schema.json",
"keepForSeconds": 86400,
"maxRecords": 1000
},
{
"type": "flags",
"schemaVersion": "1",
"schemaRef": "schemas/bridge/flags.snapshot.schema.json",
"keepForSeconds": 86400,
"maxRecords": 1000
}
],
"queryTemplates": [
{
"key": "scum.player.by-id",
"title": "Find SCUM player by ID",
"permission": "server.game-client.read",
"engine": "sqlite",
"transportKey": "sqlite-db",
"targetKey": "db/sqlite",
"parameterSchemaRef": "schemas/bridge/queries/player-by-id.parameters.schema.json",
"resultSchemaRef": "schemas/bridge/queries/player-by-id.result.schema.json",
"maxRows": 1,
"timeoutSeconds": 10
},
{
"key": "scum.player.search",
"title": "Search SCUM players",
"permission": "server.game-client.read",
"engine": "sqlite",
"transportKey": "sqlite-db",
"targetKey": "db/sqlite",
"parameterSchemaRef": "schemas/bridge/queries/player-search.parameters.schema.json",
"resultSchemaRef": "schemas/bridge/queries/player-search.result.schema.json",
"maxRows": 50,
"timeoutSeconds": 10
},
{
"key": "scum.squad.members",
"title": "List SCUM squad members",
"permission": "server.game-client.read",
"engine": "sqlite",
"transportKey": "sqlite-db",
"targetKey": "db/sqlite",
"parameterSchemaRef": "schemas/bridge/queries/squad-members.parameters.schema.json",
"resultSchemaRef": "schemas/bridge/queries/squad-members.result.schema.json",
"maxRows": 64,
"timeoutSeconds": 10
},
{
"key": "scum.vehicle.owner",
"title": "Find SCUM vehicle owner",
"permission": "server.game-client.read",
"engine": "sqlite",
"transportKey": "sqlite-db",
"targetKey": "db/sqlite",
"parameterSchemaRef": "schemas/bridge/queries/vehicle-owner.parameters.schema.json",
"resultSchemaRef": "schemas/bridge/queries/vehicle-owner.result.schema.json",
"maxRows": 1,
"timeoutSeconds": 10
},
{
"key": "scum.flag.ownership",
"title": "Find SCUM flag ownership",
"permission": "server.game-client.read",
"engine": "sqlite",
"transportKey": "sqlite-db",
"targetKey": "db/sqlite",
"parameterSchemaRef": "schemas/bridge/queries/flag-ownership.parameters.schema.json",
"resultSchemaRef": "schemas/bridge/queries/flag-ownership.result.schema.json",
"maxRows": 1,
"timeoutSeconds": 10
}
],
"commandRetentionSeconds": 604800,
"maxCommands": 1000,
"pages": [
{
"pageKey": "operations",
"commandTypes": [
"announcement.send",
"companion.diagnostics",
"player.lookup",
"reward.deliver",
"event.start",
"restart.prepare",
"maintenance.prepare"
],
"snapshotTypes": ["companion.health", "online.sessions", "players", "squads", "vehicles", "flags"],
"queryTemplateKeys": [
"scum.player.by-id",
"scum.player.search",
"scum.squad.members",
"scum.vehicle.owner",
"scum.flag.ownership"
]
}
],
"companion": {
"profileKey": "scum-client-manager",
"configTemplateKey": "client-config",
"configSchemaRef": "schemas/companion/config.schema.json",
"configFormat": "yaml",
"platformBaseUrlSource": "run-control",
"registrationProof": "hmac-sha256",
"proofMaterialSource": "component-package",
"proofMaterialEnv": "SCUM_COMPONENT_PROOF",
"sessionMode": "component-session",
"tlsPolicy": "verify-system-roots",
"heartbeatIntervalSeconds": 30,
"commandPollIntervalSeconds": 5,
"requestTimeoutSeconds": 15
}
},
"permissions": [
"server.create",
"server.read",
"server.lifecycle",
"server.files.read",
"server.files.write",
"server.logs.read",
"server.artifacts.read",
"server.artifacts.write",
"server.remote.access",
"ai.invoke",
"server.run.distribution",
"server.dependencies.manage",
"server.client-manager.manage",
"server.game-client.read",
"server.game-client.command",
"server.game-client.maintenance"
],
"actions": {
"install": "actions/install.json",
"start": "actions/start.json",
"stop": "actions/stop.json",
"restart": "actions/restart.json",
"status": "actions/status.json"
},
"productionLifecycle": {
"operations": ["install", "enable", "disable", "upgrade", "rollback", "retire", "dependency-check"],
"dependencyPolicy": "required",
"approvalRequired": ["disable", "rollback", "retire"]
},
"pages": [
{
"key": "overview",
"title": "SCUM 概览",
"path": "/overview",
"permissions": [
"server.read",
"server.lifecycle"
],
"bridgeActions": [
"server.instances.read",
"jobs.dispatch"
]
},
{
"key": "operations",
"title": "SCUM 运维",
"path": "/operations",
"permissions": [
"server.read",
"server.game-client.read",
"server.game-client.command",
"server.game-client.maintenance",
"server.client-manager.manage",
"server.logs.read",
"server.remote.access"
],
"bridgeActions": [
"server.instances.read",
"jobs.dispatch",
"client-manager.request",
"logs.query",
"remote.access.request"
]
},
{
"key": "config",
"title": "SCUM 配置",
"path": "/config",
"permissions": [
"server.files.read",
"server.files.write",
"ai.invoke"
],
"bridgeActions": [
"files.request",
"ai.invoke"
]
},
{
"key": "logs",
"title": "SCUM 日志",
"path": "/logs",
"permissions": [
"server.logs.read",
"server.artifacts.read",
"server.remote.access",
"ai.invoke"
],
"bridgeActions": [
"logs.query",
"artifacts.open",
"remote.access.request",
"ai.invoke"
]
},
{
"key": "remote",
"title": "SCUM 远程",
"path": "/remote",
"permissions": [
"server.remote.access",
"server.files.read",
"server.files.write",
"server.lifecycle"
],
"bridgeActions": [
"remote.access.request",
"files.request",
"jobs.dispatch"
]
}
],
"ai": {
"purposes": [
"config.suggest",
"logs.diagnose"
],
"mediation": "platform",
"configWritePolicy": "review-required"
},
"runtimeProfiles": {
"discovery": [
{
"key": "steamcmd",
"kind": "command.version",
"targetKey": "steamcmd",
"required": true
},
{
"key": "scum-install",
"kind": "file.exists",
"targetKey": "server/install-root",
"required": true,
"platforms": [
"windows"
]
}
],
"lifecycleProfiles": [
{
"key": "run-local",
"mode": "local-process",
"capabilities": [
"process.install",
"process.start",
"process.stop",
"process.restart",
"process.status",
"remote.run.process.start",
"remote.run.process.stop"
],
"actionRefs": {
"install": "actions/install.json",
"start": "actions/start.json",
"stop": "actions/stop.json",
"restart": "actions/restart.json",
"status": "actions/status.json"
},
"transportKeys": [
"server-files",
"sqlite-db",
"mysql-db",
"rcon"
],
"platforms": [
"windows"
]
},
{
"key": "hosted-ftp",
"mode": "hosted-ftp-rcon",
"capabilities": [
"remote.ftp.read",
"remote.ftp.write",
"remote.run.logs.transfer",
"remote.run.rcon.command"
],
"transportKeys": [
"ftp",
"rcon"
],
"platforms": [
"windows",
"linux"
]
},
{
"key": "scum-client",
"mode": "custom-client",
"capabilities": [
"client-manager.deploy",
"client-manager.control",
"logs.read"
],
"clientManagerRef": "scum-client-manager",
"platforms": [
"windows"
]
}
],
"dependencyProbes": [
{
"key": "steamcmd",
"kind": "command.version",
"targetKey": "steamcmd",
"required": true,
"platforms": [
"windows",
"linux"
]
},
{
"key": "sqlite",
"kind": "package.installed",
"targetKey": "sqlite-driver",
"required": false,
"platforms": [
"windows",
"linux"
]
}
],
"installPlans": [
{
"key": "install-scum-server",
"title": "Install SCUM Dedicated Server",
"platforms": [
"windows"
],
"steps": [
{
"type": "steamcmd-app",
"targetKey": "server/install-root",
"packageManager": "steamcmd",
"packageName": "3792580"
}
]
},
{
"key": "install-steamcmd-linux",
"title": "Install SteamCMD",
"platforms": [
"linux"
],
"steps": [
{
"type": "package",
"targetKey": "steamcmd",
"packageManager": "apt",
"packageName": "steamcmd"
}
]
}
],
"logSources": [
{
"key": "scum-chat-events",
"kind": "file.tail",
"targetKey": "logs/chat",
"streamKey": "scum.chat",
"cursorKind": "fingerprint",
"retentionDays": 90
},
{
"key": "scum-server-events",
"kind": "file.tail",
"targetKey": "logs/server",
"streamKey": "scum.server",
"cursorKind": "fingerprint",
"retentionDays": 90
},
{
"key": "scum-login-events",
"kind": "file.tail",
"targetKey": "logs/login",
"streamKey": "scum.login",
"cursorKind": "fingerprint",
"retentionDays": 90
},
{
"key": "scum-kill-events",
"kind": "file.tail",
"targetKey": "logs/kill",
"streamKey": "scum.kill",
"cursorKind": "fingerprint",
"retentionDays": 90
},
{
"key": "scum-trade-events",
"kind": "file.tail",
"targetKey": "logs/trade",
"streamKey": "scum.trade",
"cursorKind": "fingerprint",
"retentionDays": 90
},
{
"key": "scum-admin-events",
"kind": "file.tail",
"targetKey": "logs/admin",
"streamKey": "scum.admin",
"cursorKind": "fingerprint",
"retentionDays": 90
},
{
"key": "scum-performance-events",
"kind": "file.tail",
"targetKey": "logs/performance",
"streamKey": "scum.performance",
"cursorKind": "fingerprint",
"retentionDays": 30
},
{
"key": "scum-client-events",
"kind": "client-manager",
"targetKey": "scum-client-manager",
"streamKey": "scum.client",
"cursorKind": "sequence",
"retentionDays": 30
}
],
"logEvents": [
{
"key": "scum-chat",
"title": "SCUM chat message",
"sourceKey": "scum-chat-events",
"eventType": "scum.chat",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/chat.event.schema.json",
"retentionDays": 90,
"severity": "info"
},
{
"key": "scum-login",
"title": "SCUM player login",
"sourceKey": "scum-login-events",
"eventType": "scum.login",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/login.event.schema.json",
"retentionDays": 90,
"severity": "info"
},
{
"key": "scum-logout",
"title": "SCUM player logout",
"sourceKey": "scum-login-events",
"eventType": "scum.logout",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/logout.event.schema.json",
"retentionDays": 90,
"severity": "info"
},
{
"key": "scum-kill",
"title": "SCUM player kill",
"sourceKey": "scum-kill-events",
"eventType": "scum.kill",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/kill.event.schema.json",
"retentionDays": 90,
"severity": "info"
},
{
"key": "scum-trade",
"title": "SCUM trade activity",
"sourceKey": "scum-trade-events",
"eventType": "scum.trade",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/trade.event.schema.json",
"retentionDays": 90,
"severity": "info"
},
{
"key": "scum-mine",
"title": "SCUM mine activity",
"sourceKey": "scum-server-events",
"eventType": "scum.mine",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/mine.event.schema.json",
"retentionDays": 90,
"severity": "warning"
},
{
"key": "scum-unlock",
"title": "SCUM unlock activity",
"sourceKey": "scum-server-events",
"eventType": "scum.unlock",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/unlock.event.schema.json",
"retentionDays": 90,
"severity": "warning"
},
{
"key": "scum-admin",
"title": "SCUM admin activity",
"sourceKey": "scum-admin-events",
"eventType": "scum.admin",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/admin.event.schema.json",
"retentionDays": 90,
"severity": "warning"
},
{
"key": "scum-performance",
"title": "SCUM server performance",
"sourceKey": "scum-performance-events",
"eventType": "scum.performance",
"permission": "server.logs.read",
"schemaRef": "schemas/log-events/performance.event.schema.json",
"retentionDays": 30,
"severity": "info"
}
],
"transportProfiles": [
{
"key": "server-files",
"kind": "file",
"targetKey": "server-root",
"capabilities": [
"remote.run.files.read",
"remote.run.files.write"
]
},
{
"key": "ftp",
"kind": "ftp",
"targetKey": "ftp-root",
"capabilities": [
"remote.ftp.read",
"remote.ftp.write"
]
},
{
"key": "rsync",
"kind": "rsync",
"targetKey": "rsync-root",
"capabilities": [
"remote.rsync.read",
"remote.rsync.write"
]
},
{
"key": "sqlite-db",
"kind": "sqlite",
"targetKey": "db/sqlite",
"capabilities": [
"remote.run.db.sqlite.query"
]
},
{
"key": "mysql-db",
"kind": "mysql",
"targetKey": "db/mysql",
"capabilities": [
"remote.run.db.mysql.query"
]
},
{
"key": "rcon",
"kind": "rcon",
"targetKey": "rcon",
"capabilities": [
"remote.run.rcon.command"
]
},
{
"key": "client-rcon",
"kind": "rcon",
"targetKey": "client/rcon",
"capabilities": [
"remote.run.rcon.command"
]
}
],
"clientManagers": [
{
"key": "scum-client-manager",
"displayName": "SCUM Client Manager",
"version": "1.0.0",
"repository": {
"url": "https://github.com/F88888/scum_client.git",
"revisionPolicy": "branch",
"branch": "main"
},
"supportedTargets": [
{
"os": "windows",
"arch": "amd64"
}
],
"build": {
"system": "go",
"entryRef": "main.go"
},
"configTemplates": [
{
"key": "client-config",
"templateRef": "config.yaml.example",
"outputRef": "config.yaml"
}
],
"outputArtifacts": [
"scum_client.exe"
],
"deployment": {
"mode": "run-supervised",
"executableRef": "scum_client.exe",
"autoStart": true,
"requiredRunCapabilities": [
"client-manager.deploy",
"client-manager.control",
"client-manager.update",
"client-manager.rollback",
"client-manager.uninstall"
]
},
"lifecycle": {
"actions": ["start", "stop", "restart", "status", "update", "rollback", "uninstall"],
"startupTimeoutSeconds": 60,
"stopTimeoutSeconds": 30
},
"health": {
"mode": "component-heartbeat",
"intervalSeconds": 30,
"degradedAfterSeconds": 90,
"offlineAfterSeconds": 120,
"requiredCapabilities": ["component.register", "component.heartbeat", "component.health", "component.control", "game-client.bridge", "logs.stream"]
},
"compatibility": {
"minimumVersion": "1.0.0",
"allowDowngrade": false
},
"updatePolicy": {
"strategy": "manual-staged",
"requireApproval": true,
"healthConfirmationSeconds": 60,
"retainPrevious": true
}
}
]
}
}