README.md
1# Resource directory (default)
2
3The contents of the resource directory define the assets available to
4FreeOrion, as well as logic for modifiable content.
5These assets determine the appearance and functionality of FreeOrion.
6
7While much of the content within this directory is required in any resource
8directory, most is either
9* required only from inclusion in other entries
10* strictly optional
11
12Each sub-directory has an accompanying README file within it.
13This file should give a guideline for any entries or files required by
14FreeOrion if a new resource directory is created.
15
16An alternate resource directory can be specified with the
17--resource.path command line flag, or by changing the resource.path node in the
18user's config.xml.
19See http://www.freeorion.org/index.php/Config.xml for details on the config.xml
20file.
21
22## Contents
23
24* customizations/ - User customizations
25* data/ - Contains data files used by FreeOrion, including graphics, fonts,
26and sound.
27* python/ - All content processed by python scripts are located here. This
28is logic for AI decisions, events that occur each turn, and creation of a new
29universe when starting a new game.
30* scripting/ - This directory contains the definitions of content within
31FreeOrion.
32* shaders/ - Shader effects applied to various graphics during specific game
33events.
34* stringtables/ - Language translations. The only required file is
35**en.txt**, which is also a fallback for any other translations. Any
36corrections to translations, or updates for omitted languages are welcome.
37* content_specific_parameters.txt - **This file and the contained entries are
38required by FreeOrion**, the entries should be modified to reflect related
39content changes. See file for details.
40* COPYING - License info related to any content in this directory.
41**Required file and content.**
42* credits.xml - Acknowledgments of those who have made FreeOrion possible.
43**Required file and content.**
44* empire_colors.xml - Color options available for empires to select from.
45**This file containing at least one GG::Clr node is required.**
46