OmsiLaunch-documentatie
Vertaling van de oorspronkelijke Engelse pagina voor OmsiLaunch 0.1.0-beta3. De Engelse pagina is normatief: bij verschillen gelden de Engelse pagina en de code.
Dit is de normatieve Engelstalige documentatie van OmsiLaunch 0.1.0-beta3, de basislijn na de hardeningronde. OmsiLaunch biedt programmeerbaar starten, sessie-eigendom en runtimebesturing voor precies één OMSI 2-build, profiel Omsi23004_692EBFBF. Elke pagina onder docs/ beschrijft wat de huidige code doet; als een pagina en de code van elkaar afwijken, is de code leidend en is de pagina een bug.
Stabiliteitsbegrippen die overal worden gebruikt: STABLE_BETA, EXPERIMENTAL, PARTIAL, INTERNAL, UNAVAILABLE. Vlaggen die worden geparsed maar niets doen, zijn gemarkeerd als ACCEPTED_FOR_COMPATIBILITY / CURRENTLY_NO_EFFECT. Niets wordt runtime-gevalideerd genoemd tenzij de runtimevalidatiestatus dat vermeldt.
Wie leest wat#
| Doelgroep | Begin hier | Daarna |
|---|---|---|
| Gebruikers (CLI, snelkoppelingen, sessieprofielen) | Installatie, Eerste sessie | CLI-referentie, CLI-voorbeelden, Sessieprofielen, Windows-systeemvak, Exitcodes |
Integrators (OmsiLaunch.Api, lokale IPC) | Snelstart publieke API, Referentie publieke API, LaunchSpec-referentie | Sessielevenscyclus, Runtimebesturing, Capabilities, Local control / IPC, Foutreferentie |
| Beheerders (release, validatie, grenzen) | Packaging, Model van de permanente plugin | Transacties en recovery, Compatibiliteit, Bekende beperkingen, Runtimevalidatiestatus |
Navigatie#
| Pagina | Doel |
|---|---|
| Aan de slag | Eén sessie plannen, starten, observeren en stoppen vanuit de OMSI-hoofdmap. |
| Installatie | Vereisten, het pakket uitpakken in de OMSI-hoofdmap, controleren met /version, schoon verwijderen. |
| Snelstart publieke API | Een volledig .NET-programma dat één sessie plant, start, uitleest en stopt. |
| CLI-referentie | Elke vlag, elk opdrachtwoord en elke hiërarchische route van OmsiLaunch.exe / OmsiLaunchW.exe. |
| CLI-voorbeelden | Opdrachtregels om te kopiëren en te plakken voor veelvoorkomende taken. |
| LaunchSpec-referentie | Elke LaunchSpec-eigenschap en elke enumwaarde, JSON-laadregels voor /spec. |
| Referentie sessieprofielen | profile.yaml-schema omsilaunch.session-profile/v1, sleutels, limieten, voorrang. |
| Referentie publieke API | IOmsiLaunch, publieke records en enums, stabiliteit per member. |
| Inventaris publieke API | Gegenereerde lijst van elk publiek type en elke member met signatuur en stabiliteit. |
| Runtimebesturing | Runtimeopdrachtkanaal, timeouts, handles, stopsemantiek. |
| Referentie capabilities | Capabilitycatalogus en elke publieke runtime-operatie-id met zijn classificatie. |
| Sessielevenscyclus | SessionState-overgangen, wat StartSessionAsync belooft, hoe een sessie eindigt. |
| Transacties en recovery | Journalstatussen, back-ups, herstelverificatie, sessieverwijderingen, crashrecovery. |
| Model van de permanente plugin | De plugin-closure plugins\OmsiLaunch.*, integriteit op basis van het manifest, wat een sessie nooit aanraakt. |
| Local control / IPC | Named-pipe-protocol 0.1, endpoint per installatie, session_id-binding, vertrouwensmodel. |
| OmsiLaunchW.exe | De Windows-host (zonder console): verschillen met OmsiLaunch.exe, /silent, dialoogvensters, exitcodes. |
| Windows-systeemvak | Indicator in het systeemvak (meldingsgebied): pictogram, menu, statusvenster veld voor veld, sessie beëindigen, herstart van Verkenner (Explorer). |
| Foutreferentie | Elke OL_E_*- / OL_W_*-code met categorie en betekenis. |
| Exitcodes | PublicExitCode-waarden 0 tot en met 10 en shimcodes 100 tot en met 106 van de bootstrapper. |
| Packaging / installatie-indeling | Bestanden in de release-ZIP, release-manifest.json, indeling van .omsilaunch\. |
| Compatibiliteit / ondersteunde OMSI-builds | De ene ondersteunde Omsi.exe-hash, de geaccepteerde Steam-LAA-hash, platformvereisten. |
| Bekende beperkingen | Wat in deze bèta niet ondersteund, gedeeltelijk of een geaccepteerd risico is. |
| Runtimevalidatiestatus | Wat onder OMSI is uitgevoerd, wat alleen offline is uitgevoerd, wat nog een echte sessie nodig heeft. |
Pagina's in de hoofdmap die voor beheerders normatief blijven: README.md, PUBLIC-API.md, RUNTIME-CONTROL.md, RUNTIME-CAPABILITIES.md, BUILD-PROFILES.md, IMPLEMENTATION-STATUS.md, TESTING-AND-VALIDATION.md, POST-RELEASE-BACKLOG.md. Zij vatten samen; de pagina's hierboven vormen de gedetailleerde referentie. Historische pagina's staan in het documentatiemanifest.
Hoe deze documentatie synchroon wordt gehouden#
Een documentatiegate, tests\OmsiLaunch.DocumentationTests, compileert tegen OmsiLaunch.Api en OmsiLaunch.Core en vergelijkt de pagina's hierboven met de code die het publieke oppervlak definieert:
| Gate | Controleert |
|---|---|
docs.cli-flags | Elk item van CliInput.KnownFlags staat in de CLI-referentie als `/flag` of `/flag:`; elk item van CliInput.AcceptedNoEffectFlags is op zijn regel gemarkeerd als ACCEPTED_FOR_COMPATIBILITY / CURRENTLY_NO_EFFECT; elk opdrachtwoord en elke route van CliInput.HierarchicalRoutes staat erin met zijn runtime-operatie; elke PublicExitCode-waarde heeft een rij | n | in de exitcodetabel. |
docs.capabilities | Elke id van PublicCapabilityRegistry.All, elk item van PublicCapabilityRegistry.PublicRuntimeOperationIds en elke naam van PublicCapabilityClassification staat in de capabilityreferentie. |
docs.errors | Elke code van PublicErrorCodes.All staat in de foutreferentie, en geen enkele OL_E_*- / OL_W_*-literal in src\ of tools\OmsiLaunch.Cli\ ontbreekt in PublicErrorCodes. |
docs.public-api | Elk geëxporteerd type van OmsiLaunch.Api, elke enumwaarde en elke member van IOmsiLaunch staat in de referentie van de publieke API, en alle vijf stabiliteitsbegrippen worden gebruikt. |
docs.launchspec | Elke publieke eigenschap die vanuit LaunchSpec bereikbaar is en elke waarde van de bijbehorende enums staat in de LaunchSpec-referentie. |
docs.session-profiles | Elke sleutel van SessionProfileCompiler.SchemaKeys, de schema-identifier en de limiet van 256 KiB staan in de referentie van de sessieprofielen. |
docs.structure | Elke pagina in de navigatietabel bestaat. |
docs.links | Elke relatieve link in docs\**\*.md (met uitzondering van docs\localized\) en in de *.md-bestanden in de hoofdmap verwijst naar een bestaand bestand of een bestaande map. |
docs.localization | Elke locale die in docs\localized\LOCALIZATION-MANIFEST.md staat, heeft elke pagina van de gelokaliseerde set; elke pagina behoudt de koppen, tabellen en codeblokken van de Engelse pagina, elke inline-codespan (vlaggen, capability- en operatie-id's, foutcodes, sleutels, identifiers) en elke link, en haar relatieve links zijn geldig. |
De gate is een van de suites die door tools\Invoke-OfflineValidation.ps1 worden uitgevoerd (overslaan met -SkipDocs). Hij draait offline, start OMSI nooit en laat de build mislukken als een vlag, route, capability, foutcode, enumwaarde of publiek type ongedocumenteerd is of als een link niet werkt. Hij controleert geen lopende tekst, dus een pagina kan het gedrag nog steeds verkeerd beschrijven; meld dat als een bug in die pagina.
Vertalingen#
docs\localized\<locale>\ bevat volledige vertalingen van deze 0.1.0-beta3-documentatie voor pt-BR, pt-PT, en-GB, fr-FR, de-DE, es-ES, es-LATAM, it-IT, pl-PL, nl-NL, ru-RU, zh-CN, zh-TW en ja-JP. De paginaset, de locale-hoofdmappen en de pagina's die bewust niet worden vertaald, staan in localized/LOCALIZATION-MANIFEST.md. Vertalingen laten elke opdracht, vlag, identifier, foutcode en elk voorbeeld van de Engelse pagina's ongewijzigd, en de gate docs.localization controleert dat. De Engelse pagina's blijven de normatieve bron: waar een vertaling ervan afwijkt, zijn de Engelse pagina en de code gezaghebbend, en is de vertaling een bug.