package ngld.knossos

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CancelTask (TaskRequest, SuccessResponse)

  client.proto:404

• rpc CheckForProgramUpdates (NullMessage, UpdaterInfoResult)

  client.proto:391

  message UpdaterInfoResult

  client.proto:234

  • string updater = 1

  • string knossos = 2

• rpc DepSnapshotChange (DepSnapshotChangeRequest, SuccessResponse)

  client.proto:405

  message DepSnapshotChangeRequest

  client.proto:302

  • string modid = 1

  • string version = 2

  • string dep_modid = 3

  • string dep_version = 4

• rpc FixLibraryFolderPath (FixLibraryFolderPathPayload, FixLibraryFolderPathPayload)

  client.proto:396

  message FixLibraryFolderPathPayload

  client.proto:248

  • string path = 1

• rpc GetBuildModRelInfo (ModInfoRequest, BuildModRelInfoResponse)

  client.proto:410

  message BuildModRelInfoResponse

  client.proto:325

  • repeated Package packages = 1

• rpc GetHardwareInfo (NullMessage, HardwareInfoResponse)

  client.proto:398

  message HardwareInfoResponse

  client.proto:267

  • repeated string audio_devices = 1

  • repeated string capture_devices = 2

  • string default_playback = 3

  • string default_capture = 4

  • repeated string resolutions = 7

  • repeated string voices = 8

• rpc GetJoystickInfo (NullMessage, JoystickInfoResponse)

  client.proto:399

  message JoystickInfoResponse

  client.proto:278

  • repeated JoystickInfoResponse.Joystick joysticks = 1

• rpc GetLocalMods (NullMessage, SimpleModList)

  client.proto:379

• rpc GetModDependencies (ModInfoRequest, ModDependencySnapshot)

  client.proto:381

  message ModDependencySnapshot

  client.proto:154

  • map<string, string> dependencies = 1

  • map<string, ModDependencySnapshot.ModInfo> available = 2

• rpc GetModFlags (ModInfoRequest, FlagInfo)

  client.proto:382

• rpc GetModInfo (ModInfoRequest, ModInfoResponse)

  client.proto:380

• rpc GetModInstallInfo (ModInfoRequest, InstallInfoResponse)

  client.proto:389

  message InstallInfoResponse

  client.proto:195

  • string title = 1

  • repeated InstallInfoResponse.ModInfo mods = 2

• rpc GetRemoteModInfo (ModInfoRequest, ModInfoResponse)

  client.proto:388

• rpc GetRemoteMods (NullMessage, SimpleModList)

  client.proto:387

• rpc GetSettings (NullMessage, Settings)

  client.proto:376

• rpc GetSimpleModList (NullMessage, SimpleModListResponse)

  client.proto:409

  message SimpleModListResponse

  client.proto:315

  • repeated SimpleModListResponse.ModInfo mods = 1

• rpc GetVersion (NullMessage, VersionResult)

  client.proto:394

  message VersionResult

  client.proto:239

  • string version = 1

  • string commit = 2

• rpc HandleRetailFiles (HandleRetailFilesRequest, SuccessResponse)

  client.proto:397

  message HandleRetailFilesRequest

  client.proto:252

  • HandleRetailFilesRequest.Operation op = 1

  • string installer_path = 2

  • string library_path = 4

  • uint32 ref = 3

• rpc InstallMod (InstallModRequest, SuccessResponse)

  client.proto:390

  message InstallModRequest

  client.proto:221

  • uint32 ref = 1

  • repeated InstallModRequest.Mod mods = 4

• rpc LaunchMod (LaunchModRequest, SuccessResponse)

  client.proto:385

  message LaunchModRequest

  client.proto:23

  • string modid = 1

  • string version = 2

  • string label = 3

• rpc LoadFSOSettings (NullMessage, FSOSettings)

  client.proto:400

• rpc OpenDebugLog (NullMessage, TaskResult)

  client.proto:407

• rpc OpenLink (OpenLinkRequest, SuccessResponse)

  client.proto:395

  message OpenLinkRequest

  client.proto:244

  • string link = 1

• rpc ResetModFlags (ModInfoRequest, FlagInfo)

  client.proto:384

• rpc SaveBuildMod (SaveBuildModRequest, SuccessResponse)

  client.proto:411

  message SaveBuildModRequest

  client.proto:329

  • optional ModMeta mod = 1

• rpc SaveFSOSettings (FSOSettings, SuccessResponse)

  client.proto:401

• rpc SaveModFlags (SaveFlagsRequest, SuccessResponse)

  client.proto:383

  message SaveFlagsRequest

  client.proto:176

  • map<string, bool> flags = 1

  • string freeform = 2

  • string modid = 3

  • string version = 4

• rpc SaveSettings (Settings, SuccessResponse)

  client.proto:377

• rpc ScanLocalMods (TaskRequest, SuccessResponse)

  client.proto:378

• rpc SyncRemoteMods (TaskRequest, SuccessResponse)

  client.proto:386

• rpc UninstallMod (UninstallModRequest, SuccessResponse)

  client.proto:403

  message UninstallModRequest

  client.proto:296

  • string modid = 1

  • repeated string versions = 2

  • uint32 ref = 3

• rpc UninstallModCheck (UninstallModCheckRequest, UninstallModCheckResponse)

  client.proto:402

  message UninstallModCheckRequest

  client.proto:287

  • string modid = 1

  message UninstallModCheckResponse

  client.proto:291

  • repeated string versions = 1

  • map<string, string> errors = 2

• rpc UpdateKnossos (TaskRequest, SuccessResponse)

  client.proto:393

• rpc UpdateLocalModList (TaskRequest, SuccessResponse)

  client.proto:406

• rpc UpdateUpdater (TaskRequest, SuccessResponse)

  client.proto:392

• rpc VerifyChecksums (VerifyChecksumRequest, SuccessResponse)

  client.proto:408

  message VerifyChecksumRequest

  client.proto:309

  • string modid = 1

  • string version = 2

  • uint32 ref = 3

• rpc Wakeup (NullMessage, WakeupResponse)

  client.proto:375

  message WakeupResponse

  client.proto:33

  • bool success = 1

  • string version = 2

  • string os = 3

• rpc CheckToken (NullRequest, SessionResponse)

  service.proto:146

  message SessionResponse

  service.proto:40

  • bool valid = 1

  • string username = 2

• rpc GetModDetails (ModDetailsRequest, ModDetailsResponse)

  service.proto:154

  message ModDetailsRequest

  service.proto:91

  • string modid = 1

    required

  • bool latest = 2

  • string version = 3

  • bool request_downloads = 4

  message ModDetailsResponse

  service.proto:112

  • string title = 1

  • string version = 2

  • uint32 type = 3

  • uint32 stability = 4

  • string description = 5

  • string banner = 6

  • string release_thread = 7

  • repeated string screenshots = 8

  • repeated string videos = 9

  • optional google.protobuf.Timestamp released = 10

  • optional google.protobuf.Timestamp updated = 11

  • repeated string versions = 12

  • repeated ModDownloadPackage downloads = 13

• rpc GetModList (ModListRequest, ModListResponse)

  service.proto:153

  message ModListRequest

  service.proto:66

  • int32 offset = 1

    required

  • int32 limit = 2

  • string query = 3

  • ModListRequest.SortType sort = 4

  message ModListResponse

  service.proto:86

  • int32 count = 1

  • repeated ModListItem mods = 2

• rpc GetVersions (NullRequest, VersionsResponse)

  service.proto:158

  message VersionsResponse

  service.proto:140

  • map<string, string> versions = 1

• rpc Login (LoginRequest, LoginResponse)

  service.proto:145

  message LoginRequest

  service.proto:28

  • string username = 1

    required

  • string password = 2

    required

  message LoginResponse

  service.proto:35

  • string token = 1

  • bool success = 2

• rpc PreparePasswordReset (TokenRequest, TokenResponse)

  service.proto:150

  message TokenResponse

  service.proto:19

  • bool success = 1

  • string token = 2

• rpc Register (RegisterRequest, BoolResponse)

  service.proto:147

  message RegisterRequest

  service.proto:45

  • string username = 1

    required

  • string email = 2

    required

  • string password = 3

    required

• rpc RequestModInstall (ModInstallRequest, ModInstallResponse)

  service.proto:156

  message ModInstallRequest

  service.proto:129

  • string modid = 1

  • string version = 2

  message ModInstallResponse

  service.proto:134

  • string error = 1

  • repeated Release releases = 2

    a list containing the requested mod and all dependencies

• rpc ResetPassword (ResetPasswordRequest, BoolResponse)

  service.proto:151

  message ResetPasswordRequest

  service.proto:59

  • string token = 1

    required

  • string password = 2

    required

• rpc StartPasswordReset (StartPasswordResetRequest, BoolResponse)

  service.proto:149

  message StartPasswordResetRequest

  service.proto:54

  • string email = 1

    required

• rpc VerifyAccount (TokenRequest, BoolResponse)

  service.proto:148

Used as response type in: Nebula.Register, Nebula.ResetPassword, Nebula.StartPasswordReset, Nebula.VerifyAccount

• bool success = 1

Utilities

Used in: PackageArchive, PackageFile

• string algo = 1

• bytes digest = 2

• map<string, ChecksumPack.Archive> archives = 4

Used in: ChecksumPack

• repeated Archive.File files = 1

• bytes checksum = 2

• uint64 size = 3

• repeated string mirrors = 4

Used in: Archive

• string filename = 1

• bytes checksum = 2

• uint32 size = 3

• uint32 ref = 1

• oneof payload

  • LogMessage message = 2

  • ProgressMessage progress = 3

  • TaskResult result = 4

Used in: Package

• repeated string required_features = 1

Used in: Package

• string modid = 1

• string constraint = 2

• repeated string packages = 3

Used in: Package

• string path = 1

• string label = 2

• uint32 priority = 3

• bool debug = 4

Used as request type in: Knossos.SaveFSOSettings

Used as response type in: Knossos.LoadFSOSettings

• optional FSOSettings.DefaultSettings Default = 1

• optional FSOSettings.SoundSettings Sound = 2

• optional FSOSettings.VideoSettings Video = 3

• optional FSOSettings.ForceFeedbackSettings ForceFeedback = 4

• optional FSOSettings.PXOSettings PXO = 5

Used in: FSOSettings

• string CurrentJoystickGUID = 1

• uint32 CurrentJoystick = 2

• string LastPlayer = 3

• string VideocardFs2open = 4

  format: "OGL -(%dx%d)x%d bit" width height depth note: "VK -" is also recognised but the Vulkan renderer isn't done, yet, so it's not functional.

• string GammaD3D = 5

  default: 1.0

• string Language = 6

  valid options: https://github.com/scp-fs2open/fs2open.github.com/blob/22b16c32d497e6f727bfec218e0f408e3a08f354/code/localization/localize.cpp#L36-L41

• uint32 SpeechVolume = 7

  default: 100

• string SpeechVoice = 8

• bool SpeechTechroom = 9

• bool SpeechBriefings = 10

• bool SpeechIngame = 11

• bool SpeechMulti = 12

• bool EnableJoystickFF = 13

• bool EnableHitEffect = 14

• uint32 TextureFilter = 18

  default: 1, 0 = bilinear, 1 = trilinear

• bool ForceFullscreen = 16

• uint32 MaxFPS = 17

• uint32 ScreenshotNum = 19

• string NetworkConnection = 20

• string ConnectionSpeed = 21

Used in: FSOSettings

• uint32 Strength = 1

  default: 100

Used in: FSOSettings

• string Login = 1

• string Password = 2

• string SquadName = 3

Used in: FSOSettings

• string PlaybackDevice = 1

• string CaptureDevice = 2

• uint32 Quality = 3

  default: medium, 0 = low, 1 = medium, 2 = high

• string SampleRate = 4

  default: 48000 for high, 44100 for medium, 22050 for low

• bool EnableEFX = 5

Used in: FSOSettings

• uint32 Display = 1

Used in: PackageArchive, Release, SimpleModList.Item

• string fileid = 1

• repeated string urls = 2

Used as response type in: Knossos.GetModFlags, Knossos.ResetModFlags

• map<string, FlagInfo.Flag> flags = 1

• string freeform = 2

Used in: FlagInfo

• string label = 1

• string flag = 5

• string category = 2

• bool enabled = 3

• string help = 4

Used in: HandleRetailFilesRequest

• UNKNOWN = 0

• AUTO_STEAM = 1

• AUTO_GOG = 2

• MANUAL_GOG = 3

• MANUAL_FOLDER = 4

Used in: Package

• string id = 1

• string package = 2

Used in: InstallInfoResponse

• string id = 5

• string title = 1

• string version = 2

• string notes = 3

• repeated Package packages = 4

Used in: ModInfo

• string name = 1

• PackageType type = 2

• string notes = 3

• repeated Dependency dependencies = 4

Used in: InstallModRequest

• string modid = 1

• string version = 2

• repeated string packages = 3

Used in: JoystickInfoResponse

• string name = 1

• string UUID = 2

Used in: ClientSentEvent

• LogMessage.LogLevel level = 1

• string message = 2

• string sender = 3

• optional google.protobuf.Timestamp time = 4

Used in: LogMessage

• UNKNOWN = 0

• TRACE = 1

• DEBUG = 2

• INFO = 3

• WARNING = 4

• ERROR = 5

• FATAL = 6

• string modid = 1

• string title = 2

• ModType type = 3

• repeated string tags = 5

Used in: ModDependencySnapshot

• repeated string versions = 1

Used in: ModDownloadPackage

• string label = 1

• string checksum = 2

• uint32 size = 3

• repeated string links = 4

Used in: ModDetailsResponse

• string name = 1

• string notes = 2

• repeated ModDownloadArchive archives = 3

• repeated ModIndex.Mod mods = 1

Used in: ModIndex

• string modid = 1

• optional google.protobuf.Timestamp last_modified = 4

• repeated google.protobuf.Timestamp packs_last_modified = 2

• bytes version_checksum = 3

Used as request type in: Knossos.GetBuildModRelInfo, Knossos.GetModDependencies, Knossos.GetModFlags, Knossos.GetModInfo, Knossos.GetModInstallInfo, Knossos.GetRemoteModInfo, Knossos.ResetModFlags

• string id = 1

• string version = 2

Used as response type in: Knossos.GetModInfo, Knossos.GetRemoteModInfo

• optional Release release = 1

• optional ModMeta mod = 4

• repeated string versions = 3

• repeated ToolInfo tools = 2

Used in: ModListResponse

• string modid = 1

• string teaser = 2

• string title = 3

• string version = 5

• uint32 release_count = 4

Used in: ModListRequest

• NAME = 0

Used in: ModInfoResponse, SaveBuildModRequest

• string modid = 1

• string title = 2

• ModType type = 4

• repeated string tags = 3

Core types

Used in: Mod, ModMeta, SimpleModList.Item

• MOD = 0

• TOTAL_CONVERSION = 1

• ENGINE = 2

• TOOL = 3

• EXTENSION = 4

Used as request type in: Knossos.CheckForProgramUpdates, Knossos.GetHardwareInfo, Knossos.GetJoystickInfo, Knossos.GetLocalMods, Knossos.GetRemoteMods, Knossos.GetSettings, Knossos.GetSimpleModList, Knossos.GetVersion, Knossos.LoadFSOSettings, Knossos.OpenDebugLog, Knossos.Wakeup

(message has no fields)

Used as request type in: Nebula.CheckToken, Nebula.GetVersions

(message has no fields)

• bool dummy = 1

Used in: BuildModRelInfoResponse, Release

• string name = 1

• string folder = 2

• string notes = 3

• PackageType type = 4

• optional CpuSpec cpu_spec = 5

• bool knossos_vp = 6

• repeated Dependency dependencies = 10

• repeated PackageArchive archives = 11

• repeated PackageFile files = 12

• repeated EngineExecutable executables = 20

Used in: Package

• string id = 1

• string label = 2

• string destination = 3

• optional Checksum checksum = 4

• uint64 filesize = 5

• optional FileRef download = 6

Used in: Package

• string path = 1

• string archive = 2

  archive id

• string archive_path = 3

• uint32 filesize = 5

• optional Checksum checksum = 4

Used in: InstallInfoResponse.Package, Package

• REQUIRED = 0

• RECOMMENDED = 1

• OPTIONAL = 2

Used in: ClientSentEvent

• float progress = 1

• string description = 2

• bool error = 3

• bool indeterminate = 4

Used in: ModInfoResponse, ModInstallResponse, ReleasePack

• string modid = 1

  core meta

• string version = 2

• string folder = 7

• ReleaseStability stability = 3

• string description = 10

  mod page

• optional FileRef teaser = 11

• optional FileRef banner = 12

• string release_thread = 13

• repeated FileRef screenshots = 14

• repeated string videos = 15

• optional google.protobuf.Timestamp released = 16

• optional google.protobuf.Timestamp updated = 17

• optional google.protobuf.Timestamp json_export_updated = 25

• string notes = 20

  install

• string cmdline = 21

  launch

• repeated string mod_order = 24

• map<string, string> dependency_snapshot = 22

• bool snapshot_modified = 23

• repeated Package packages = 4

  content

• string modid = 1

• uint32 packnum = 2

• repeated Release releases = 3

Used in: Release

• STABLE = 0

• RC = 1

• NIGHTLY = 2

Used as request type in: Knossos.SaveSettings

Used as response type in: Knossos.GetSettings

• bool first_run_done = 6

• string library_path = 1

• bool update_check = 2

• bool error_reports = 3

• int32 max_downloads = 4

• int32 bandwidth_limit = 5

Used as response type in: Knossos.GetLocalMods, Knossos.GetRemoteMods

• repeated SimpleModList.Item mods = 2

Used in: SimpleModList

• string modid = 1

• ModType type = 5

• optional FileRef teaser = 2

• string title = 3

• string version = 4

• bool broken = 6

Used in: SimpleModListResponse

• string modid = 1

• string version = 2

• string title = 3

Used as response type in: Knossos.CancelTask, Knossos.DepSnapshotChange, Knossos.HandleRetailFiles, Knossos.InstallMod, Knossos.LaunchMod, Knossos.OpenLink, Knossos.SaveBuildMod, Knossos.SaveFSOSettings, Knossos.SaveModFlags, Knossos.SaveSettings, Knossos.ScanLocalMods, Knossos.SyncRemoteMods, Knossos.UninstallMod, Knossos.UpdateKnossos, Knossos.UpdateLocalModList, Knossos.UpdateUpdater, Knossos.VerifyChecksums

• bool success = 1

Used as request type in: Knossos.CancelTask, Knossos.ScanLocalMods, Knossos.SyncRemoteMods, Knossos.UpdateKnossos, Knossos.UpdateLocalModList, Knossos.UpdateUpdater

• uint32 ref = 1

Used as response type in: Knossos.OpenDebugLog

Used as field type in: ClientSentEvent

• bool success = 1

• string error = 2

Used as request type in: Nebula.PreparePasswordReset, Nebula.VerifyAccount

• string token = 1

  required

Used in: ModInfoResponse

• string label = 1

• string id = 2

• bool debug = 3

• bool fred = 4

• optional UserSettings.EngineOptions engine_options = 1

• string cmdline = 2

• string custom_build = 3

• optional google.protobuf.Timestamp last_played = 4

Used in: UserSettings

• string modid = 1

• string version = 2