API catalog
The public declarations exported by osu-files are listed below. This is auto-generated.
Database results
Beatmaps- Find and edit beatmap snapshots.Sets- Find beatmap sets and their files.Scores- Find scores by player, date, or beatmap.Collections- Find named beatmap collections.Rulesets- Find installed rulesets.RulesetSettings- Read settings for each ruleset.Skins- Find built-in and user skins.Files- Find file records by hash.Keybindings- Find key bindings.ModPresets- Find saved mod presets.Metadata- Search embedded beatmap metadata.
Other public APIs
EditSessionFileRefRealmClosedErrorRealmReadOnlyErrorStoryboardStoryboardAlphaCommandStoryboardAnimationStoryboardBlendingCommandStoryboardColourCommandStoryboardCommandGroupStoryboardFlipHCommandStoryboardFlipVCommandStoryboardLayerStoryboardLoopingGroupStoryboardRotationCommandStoryboardSampleStoryboardScaleCommandStoryboardSpriteStoryboardTriggerGroupStoryboardVectorScaleCommandStoryboardXCommandStoryboardYCommandAnchorCatchActionCommandTypeEasingGlobalActionInputKeyLoopTypeManiaActionOsuActionRulesetNameRulesetOnlineIDSliderCurveTypeTaikoActioncloneSkinIni- Signature:cloneSkinIni(document: SkinIniDocument): SkinIniDocumentcomputeSkinHash- Signature:computeSkinHash(files: object[]): stringcreateFileRef- Signature:createFileRef(filename: string, source: object, ctx?: OsuFilesContext): FileReffullSkinContentHash- Signature:fullSkinContentHash(ctx: OsuFilesContext, skin: Skin): stringgetManiaDefaults- Signature:getManiaDefaults(variant: number): KeyBindingDef[]hasFilesFolder- Signature:hasFilesFolder(ctx: Pick): booleaninit- Signature:init(path: string, options?: InitOptions): OsuFilesAPIparseOsb- Signature:parseOsb(content: string): objectparseOsu- Signature:parseOsu(content: string): OsuBeatmapparseSkinIni- Signature:parseSkinIni(content: string): SkinIniDocumentparseStoryboard- Signature:parseStoryboard(rawText: string, formatVersion: number): StoryboardserializeOsb- Signature:serializeOsb(storyboard: Storyboard, variables: Record): stringserializeOsu- Signature:serializeOsu(beatmap: OsuBeatmap): stringserializeSkinIni- Signature:serializeSkinIni(document: SkinIniDocument): stringserializeStoryboard- Signature:serializeStoryboard(storyboard: Storyboard): stringBeatmapModuleBeatmapSetModuleFileModuleScoreModuleSkinModuleBeatmapBeatmapCollectionBeatmapCollectionModuleBeatmapDifficultyBeatmapMetadataBeatmapMetadataModuleBeatmapMetadataSnapshotBeatmapSetBeatmapSetDataBeatmapSetEditorBeatmapSetFileBeatmapSetSnapshotBeatmapSnapshotBeatmapUserSettingsBlendingModeCollectionSnapshotFileFileCleanupReportFileSnapshotHitCircleHitHoldHitObjectHitSliderHitSpinnerImportedSkinDataInitOptionsIntegrityIssueIntegrityModuleIntegrityReportKeyBindingKeyBindingDefKeyBindingModuleKeyBindingSnapshotMigrationEventMigrationReportModPresetModPresetModuleModPresetSnapshotOsuBeatmapOsuColourOsuDifficultyOsuEditorOsuEventOsuFilesAPIOsuGeneralOsuMetadataOverlayPositionOwnedFileEditorRealmFileRealmNamedFileUsageRealmUserRulesetRulesetModuleRulesetSettingRulesetSettingModuleRulesetSettingSnapshotRulesetShortNameRulesetSnapshotSampleSetScoreScoreEditorScoreSnapshotSkinSkinEditorSkinIniSkinIniCatchTheBeatSkinIniColourSkinIniColoursSkinIniDocumentSkinIniEntryNodeSkinIniFontsSkinIniGeneralSkinIniLineNodeSkinIniManiaSkinIniManiaConfigurationSkinIniNodeSkinIniParseIssueSkinIniSectionNodeSkinIniValueSkinSnapshotSliderExtrasStoryboardLayerNameTimingPointTriggerName