simfile.assets
==============

.. py:module:: simfile.assets


Classes
-------

.. autoapisummary::

   simfile.assets.Assets


Module Contents
---------------

.. py:class:: Assets(simfile_dir: str, *, simfile: Optional[simfile.types.Simfile] = None, filesystem: simfile._private.fs.FS = NativeOSFS(), **kwargs)

   Asset loader for a simfile directory.

   This loader uses the same heuristics as StepMania to determine a
   default path for assets not specified in the simfile. For example, if
   the BACKGROUND property is missing or blank, StepMania will look for an
   image whose filename contains "background" or ends with "bg".

   The simfile will be loaded from the :code:`simfile_dir` unless an
   explicit :code:`simfile` argument is supplied. This is intended mostly
   as an optimization for when the simfile has already been loaded from
   disk.

   All asset paths are absolute and normalized. Keyword arguments are
   passed down to :func:`simfile.open` (and are only valid if
   :code:`simfile` is not provided).


   .. py:property:: music


   .. py:property:: banner


   .. py:property:: background


   .. py:property:: cdtitle


   .. py:property:: jacket


   .. py:property:: cdimage


   .. py:property:: disc


   .. py:attribute:: simfile_dir


   .. py:attribute:: filesystem