INSTALL.txt
author David Ludwig <dludwig@pobox.com>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 9025 d09d4b578e77
child 10893 54480745c410
permissions -rw-r--r--
WinRT: bug and data-integrity fixes for SDL_GetPrefPath()

This change does a few things, all with regards to the WinRT implementation of
SDL_GetPrefPath():

1. it fixes a bug whereby SDL_GetPrefPath() did not create the directory it
returned. On other SDL platforms, SDL_GetPrefPath() will create separate
directories for its 'org' and 'app' folders. Without this, attempts to create
files in the pref-path would fail, unless those directories were first created
by the app, or by some other library the app used. This change makes sure
that these directories get created, before SDL_GetPrefPath() returns to its
caller(s).


2. it defaults to having SDL_GetPrefPath() return a WinRT 'Local' folder
on all platforms. Previously, for Windows Store apps, it would have used a
different, 'Roaming' folder. Files in Roaming folders can be automatically,
and synchronized across multiple devices by Windows. This synchronization can
happen while the app runs, with new files being copied into a running app's
pref-path. Unless an app is specifically designed to handle this scenario,
there is a chance that save-data could be overwritten in unwanted or
unexpected ways.

The default is now to use a Local folder, which does not get synchronized, and
which is arguably a bit safer to use. Apps that wish to use Roaming folders
can do so by setting SDL_HINT_WINRT_PREF_PATH_ROOT to "roaming", however it
is recommended that one first read Microsoft's documentation for Roaming
files, a link to which is provided in README-winrt.md.

To preserve older pref-path selection behavior (found in SDL 2.0.3, as well as
many pre-2.0.4 versions of SDL from hg.libsdl.org), which uses a Roaming path
in Windows Store apps, and a Local path in Windows Phone, set
SDL_HINT_WINRT_PREF_PATH_ROOT to "old".

Please note that Roaming paths are not supported on Windows Phone 8.0, due to
limitations in the OS itself. Attempts to use this will fail.
(Windows Phone 8.1 does not have this limitation, however.)


3. It makes SDL_GetPrefPath(), when on Windows Phone 8.0, and when
SDL_HINT_WINRT_PREF_PATH_ROOT is set to "roaming", return NULL, rather than
silently defaulting to a Local path (then switching to a Roaming path if and
when the user upgraded to Windows Phone 8.1).
slouken@7222
     1
slouken@7222
     2
To compile and install SDL:
slouken@7222
     3
slouken@7227
     4
    1.  Windows with Visual Studio:
slouken@7227
     5
        * Read VisualC.html
slouken@7222
     6
slouken@7227
     7
        Windows with gcc, either native or cross-compiling:
slouken@7227
     8
        * Read the FAQ at http://wiki.libsdl.org/moin.fcg/FAQWindows
slouken@7227
     9
        * Run './configure; make; make install'
slouken@7222
    10
slouken@7227
    11
        Mac OS X with Xcode:
slouken@9025
    12
        * Read docs/README-macosx.md
slouken@7222
    13
slouken@7227
    14
        Mac OS X from the command line:
slouken@7227
    15
        * Run './configure; make; make install'
slouken@7227
    16
slouken@7227
    17
        Linux and other UNIX systems:
slouken@7227
    18
        * Run './configure; make; make install'
slouken@7227
    19
slouken@7227
    20
        Android:
slouken@9025
    21
        * Read docs/README-android.md
slouken@7227
    22
slouken@7227
    23
        iOS:
slouken@9025
    24
        * Read docs/README-ios.md
slouken@7227
    25
slouken@7227
    26
        Using Cmake:
slouken@9025
    27
        * Read docs/README-cmake.md
slouken@7222
    28
slouken@7222
    29
    2.  Look at the example programs in ./test, and check out the online
slouken@7222
    30
        documentation at http://wiki.libsdl.org/
slouken@7222
    31
slouken@7222
    32
    3.  Join the SDL developer mailing list by sending E-mail to
slouken@7222
    33
    	sdl-request@libsdl.org
slouken@7222
    34
        and put "subscribe" in the subject of the message.
slouken@7222
    35
slouken@7222
    36
        Or alternatively you can use the web interface:
slouken@7222
    37
            http://www.libsdl.org/mailing-list.php
slouken@7222
    38
slouken@7222
    39
That's it!
slouken@7222
    40
Sam Lantinga <slouken@libsdl.org>