Skip to content

Folder structure

andy edited this page May 7, 2024 · 3 revisions

Root folder

Ruleset-related folder:

  • Beatmap: Beatmap format, include encoding end decoding.
  • Configuration: Gameplay/editor configuration.
  • Difficulty: Calculate difficulty.
  • Edit: All the things for the main editor, checks and non-graphic logic(e.g. change handlers)
  • Judgements: for the hit-object judgement result.
  • Localisation: all class for mapping the translation.
  • Mods: mods.
  • Objects: hit-object and drawable-relate things.
  • Replays: record the replay.
  • Resources: gameplay resource file.
  • Scoring: class for record the score.
  • Skinning: skinning for the hit-object
  • Statistics: drawable info in the result screen.
  • UI: gameplay element(e.g. playfield).
  • Utils: Utility

Non-ruleset related folder(might only available in this ruleset):

  • Bindables: Customized bindable.
  • Extensions: Shared extension.
  • Flags: A special class to add/remove enum to the property.
  • Graphics: Graphic-related drawable/sprite use in everywhere?
  • IO: Class for read/write.
  • Online: All api-related things.
  • Overlays: all overlays(e.g. changelog overlay).
  • Screens: extra screen to extend the page.
  • Stages: metadata for describe karaoke text layout/animation.
  • Timing: customized clock.

Common folder struct:

Graphic: Graphic-related drawable/sprite use in everywhere?

  • Containers:
  • Sprites:
  • UserInterface
  • UserInterfaceV2

Components: Guess all small elements used in the base class will be placed into this folder. Drawable: class are drawable compared to parent folder. see DrawableStoryboardAnimation

Class

  1. Abstract class should be in the root folder.
Clone this wiki locally