Difference between revisions of "IGNFileFormat"

From The Battle for Wesnoth Wiki
(Rewrote most text for clarity and grammar, tweaked page formatting)
m (_server.ign does NOT implicitly include the defaults)
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== What is an .ign file? ==
+
__NOTOC__
 
 
 
When you upload an add-on, some files and directories are ignored and not uploaded.
 
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.
+
If you would prefer to have more control over which files and directories should be ignored, you should provide a <b>_server.ign</b> file containing a list of filter patterns. Each file or directory matching any entry of the _server.ign file will not be included when uploaded to the add-ons server.
 
 
== What goes into an .ign file? ==
 
  
* Each line should contain exactly one pattern and nothing else.
+
== Where do I put the file, and what goes in it? ==
* '''*''' 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 placed within the root level of your add-on (<i>data/add-ons/addon_name/_server.ign</i>).
  
There are two alternatives:
+
A specific format is required:
  
* Place ''addonname''.ign next to the ''addon_name/'' directory (old style), or
+
* {{DevFeature1.13|0}}: Blank lines and lines beginning with '<code># </code>' (space required) are ignored.
* Place ''_server.ign'' within the ''addon_name/'' directory (new style).
+
* Each line should contain exactly one pattern.
 +
* <code>*</code> and <code>?</code> wildcards are supported (<code>?</code> stands for any single character, <code>*</code> stands for any number of any characters).
 +
* {{DevFeature1.13|12}}: <code>+</code> wildcards are also supported: it stands for one or more characters.
 +
* Patterns with a trailing forward slash '<code>/</code>' will match directories; the rest only match files.
  
== How does this work? ==
+
==== Default values ====
  
If there is no file, the default filter as of Wesnoth 1.10 is:
+
If there is no custom _server.ign file present, a default filter will be used instead, which is as follows:
  
  .*
+
  .+
  .*/
+
  .+/
  __MACOSX
+
  __MACOSX/
 
  #*#
 
  #*#
 
  *~
 
  *~
Line 41: Line 39:
 
  *.vbs
 
  *.vbs
 
  *.o
 
  *.o
 +
*.ini  {{DevFeature1.13|12}}
 
  Thumbs.db
 
  Thumbs.db
 
  *.wesnoth
 
  *.wesnoth
 
  *.project
 
  *.project
  
If there is an .ign file, the filter is the content of the file. Each file or directory matching any entry of the .ign file will not be uploaded to the add-ons server.
+
If you create a custom _server.ign, you should add these entries to it.
 +
 
 +
== See Also ==
 +
 
 +
* [[PblWML]]
  
 
[[Category:Create]]
 
[[Category:Create]]

Latest revision as of 12:35, 21 December 2019

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 a _server.ign file containing a list of filter patterns. Each file or directory matching any entry of the _server.ign file will not be included when uploaded to the add-ons server.

Where do I put the file, and what goes in it?

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

A specific format is required:

  • (Version 1.13.0 and later only): Blank lines and lines beginning with '# ' (space required) are ignored.
  • Each line should contain exactly one pattern.
  • * and ? wildcards are supported (? stands for any single character, * stands for any number of any characters).
  • (Version 1.13.12 and later only): + wildcards are also supported: it stands for one or more characters.
  • Patterns with a trailing forward slash '/' will match directories; the rest only match files.

Default values

If there is no custom _server.ign file present, a default filter will be used instead, which is as follows:

.+
.+/
__MACOSX/
#*#
*~
*-bak
*.swp
*.pbl
*.ign
_info.cfg
*.exe
*.bat
*.cmd
*.com
*.scr
*.sh
*.js
*.vbs
*.o
*.ini  (Version 1.13.12 and later only)
Thumbs.db
*.wesnoth
*.project

If you create a custom _server.ign, you should add these entries to it.

See Also

This page was last edited on 21 December 2019, at 12:35.