file structure - Githubissues

karolherbst / Gamekeeper-Framework

Library for hooking up game stores and merging them into one single library

GNU Lesser General Public License v2.1

2 stars 0 forks source link

file structure #15

Closed karolherbst closed 10 years ago

karolherbst commented 10 years ago

I was thinking a little bit about the file structure we should use

Linux:

/usr/lib/libgamelib.so
/usr/include/gamelib/ for headers
/usr/share/gamelib/ for resources gamelib is using or the clients, initial store/game profiles, etc...
$XDG_CONFIG_HOME/gamelib/ for settings set through the Config API
$XDG_DATA_HOME/gamelib/ for databases, synced store/game profiles, etc..
$XDG_CACHE_HOME/gamelib/ for cached data: game icons, other downloaded files
$XDG_RUNTIME_DIR/gamelib/ for open sockets, other runtime only stuff

Mac OS X:

use NSBundle and NSSearchPathForDirectoriesInDomains. Example: http://www.cocoawithlove.com/2010/05/finding-or-creating-application-support.html
There is also an API for runtime only/cached stuff, but I don't find it.

Windows:

I am not sure if here is a special way to save data, but I guess we should use this ~/AppData directory, but everything beyond that we should be allowed to do whatever we want.

inside our installation and application data directory, there should be a plugins directory.

karolherbst commented 10 years ago

it doesn't make any sense to do something else, than the best practises on the specific platforms