src/physfs.h
changeset 1274 db0abc54e263
parent 1273 6bf67c4100f9
child 1275 98f9a2a0000b
equal deleted inserted replaced
1273:6bf67c4100f9 1274:db0abc54e263
   913  * \fn int PHYSFS_setSaneConfig(const char *organization, const char *appName, const char *archiveExt, int includeCdRoms, int archivesFirst)
   913  * \fn int PHYSFS_setSaneConfig(const char *organization, const char *appName, const char *archiveExt, int includeCdRoms, int archivesFirst)
   914  * \brief Set up sane, default paths.
   914  * \brief Set up sane, default paths.
   915  *
   915  *
   916  * Helper function.
   916  * Helper function.
   917  *
   917  *
   918  * The write dir will be set to "userdir/.organization/appName", which is
   918  * The write dir will be set to the pref dir returned by
       
   919  *  \code PHYSFS_getPrefDir(organization, appName) \endcode, which is
   919  *  created if it doesn't exist.
   920  *  created if it doesn't exist.
   920  *
   921  *
   921  * The above is sufficient to make sure your program's configuration directory
   922  * The above is sufficient to make sure your program's configuration directory
   922  *  is separated from other clutter, and platform-independent. The period
   923  *  is separated from other clutter, and platform-independent.
   923  *  before "mygame" even hides the directory on Unix systems.
       
   924  *
   924  *
   925  *  The search path will be:
   925  *  The search path will be:
   926  *
   926  *
   927  *    - The Write Dir (created if it doesn't exist)
   927  *    - The Write Dir (created if it doesn't exist)
   928  *    - The Base Dir (PHYSFS_getBaseDir())
   928  *    - The Base Dir (PHYSFS_getBaseDir())
   931  * These directories are then searched for files ending with the extension
   931  * These directories are then searched for files ending with the extension
   932  *  (archiveExt), which, if they are valid and supported archives, will also
   932  *  (archiveExt), which, if they are valid and supported archives, will also
   933  *  be added to the search path. If you specified "PKG" for (archiveExt), and
   933  *  be added to the search path. If you specified "PKG" for (archiveExt), and
   934  *  there's a file named data.PKG in the base dir, it'll be checked. Archives
   934  *  there's a file named data.PKG in the base dir, it'll be checked. Archives
   935  *  can either be appended or prepended to the search path in alphabetical
   935  *  can either be appended or prepended to the search path in alphabetical
   936  *  order, regardless of which directories they were found in.
   936  *  order, regardless of which directories they were found in. All archives
       
   937  *  are mounted in the root of the virtual file system ("/").
   937  *
   938  *
   938  * All of this can be accomplished from the application, but this just does it
   939  * All of this can be accomplished from the application, but this just does it
   939  *  all for you. Feel free to add more to the search path manually, too.
   940  *  all for you. Feel free to add more to the search path manually, too.
   940  *
   941  *
   941  *    \param organization Name of your company/group/etc to be used as a
   942  *    \param organization Name of your company/group/etc to be used as a