SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Variable ServerServiceConst

    ServerService: GenService<
        {
            getServerInfo: {
                input: typeof ServerInfoRequestSchema;
                methodKind: "unary";
                output: typeof ServerInfoResponseSchema;
            };
            updateServerConfig: {
                input: typeof ServerUpdateConfigRequestSchema;
                methodKind: "unary";
                output: typeof ServerUpdateConfigResponseSchema;
            };
            updateServerConfigEntry: {
                input: typeof ServerUpdateConfigEntryRequestSchema;
                methodKind: "unary";
                output: typeof ServerUpdateConfigEntryResponseSchema;
            };
        },
    > = ...

    ServerService provides gRPC methods for managing server-level configuration in SoulFire. This service handles global settings that affect the entire SoulFire server instance, including debug logging, plugin configurations, and other server-wide preferences.

    Configuration changes are persisted to a database and trigger runtime hooks to apply settings immediately (e.g., adjusting log levels for SoulFire, Minecraft, Netty, gRPC, Hibernate, and Via components).

    All methods require appropriate permissions:

    • GetServerInfo requires READ_SERVER_CONFIG permission
    • UpdateServerConfig requires UPDATE_SERVER_CONFIG permission
    • UpdateServerConfigEntry requires UPDATE_SERVER_CONFIG permission

    Errors:

    • PERMISSION_DENIED: If the caller lacks the required permission
    • INTERNAL: If a database or processing error occurs

    from service soulfire.v1.ServerService

    Settings
    Member Visibility