Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

Environmental guidelines

SilverDimond edited this page Aug 22, 2023 · 1 revision

A set of rules plugins and cores and basically anything related to SilverAudioPlayer should follow. These rules may be followed voluntarily and if so are subject to exceptions.

File related stuff

  • Do not write/lock files
    • Do not edit the file given to you to play or examine
    • Do not write random configuration files (if you have to use the configuration directory)
    • Do not leave residual files (whatever temporary file you create for interop delete on deactivation)
  • Do not attempt to examine files and paths not provided by the user
    • Exceptions to this rule may be if they are required for interop
  • Avoid creating files, try doing what you can do in RAM

Memory related stuff

  • Try not storing everything in RAM
    • Stuff saved on disk / accessible via LAN shouldn't have to be fully loaded into RAM
  • Share large assets by storing in the respective hashset for artwork
Clone this wiki locally