IGNFileFormat

From The Battle for Wesnoth Wiki
Revision as of 16:18, 17 December 2014 by Vultraz (talk | contribs) (Removed references to old style)

What is an .ign file?

When you upload an add-on, some files and directories are ignored and not uploaded.

If you would prefer to have more control over which files and directories should be ignored, you should provide an .ign file containing a list of filter patterns.

What goes into an .ign file?

  • Each line should contain exactly one pattern and nothing else.
  • * and ? wildcards are supported (? stands for any single character, * stands for any number of any characters).
  • Patterns with a trailing forward slash (/) will match directories; the rest only match files.

Where do I put the .ign file?

The file should be named _server.ign and placed within the root level of your add-on (data/add-ons/addon_name/_server.ign).

How does this work?

If there is no custom ign file present, the default filter as of Wesnoth 1.12 is:

.*
.*/
__MACOSX
#*#
*~
*-bak
*.swp
*.pbl
*.ign
_info.cfg
*.exe
*.bat
*.cmd
*.com
*.scr
*.sh
*.js
*.vbs
*.o
Thumbs.db
*.wesnoth
*.project

If there is an .ign file, the contents of the file are used as the filter instead of the defaults. Each file or directory matching any entry of the .ign file will not be uploaded to the add-ons server.