Difference between revisions of "IGNFileFormat"
From The Battle for Wesnoth Wiki
m (→How does this work?: Typo) |
(Rewrote most text for clarity and grammar, tweaked page formatting) |
||
| Line 1: | Line 1: | ||
| − | == .ign | + | == What is an .ign file? == |
| − | + | When you upload an add-on, some files and directories are ignored and not uploaded. | |
| − | When you upload an | ||
| − | |||
| − | + | 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. | |
| − | |||
| − | |||
| − | |||
| − | === Where do I put the .ign file? == | + | == 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? == | ||
| + | |||
| + | There are two alternatives: | ||
| + | |||
| + | * Place ''addonname''.ign next to the ''addon_name/'' directory (old style), or | ||
| + | * Place ''_server.ign'' within the ''addon_name/'' directory (new style). | ||
| + | |||
| + | == How does this work? == | ||
| − | |||
If there is no file, the default filter as of Wesnoth 1.10 is: | If there is no file, the default filter as of Wesnoth 1.10 is: | ||
| Line 41: | Line 45: | ||
*.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 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. |
[[Category:Create]] | [[Category:Create]] | ||
Revision as of 20:56, 8 August 2012
Contents
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?
There are two alternatives:
- Place addonname.ign next to the addon_name/ directory (old style), or
- Place _server.ign within the addon_name/ directory (new style).
How does this work?
If there is no file, the default filter as of Wesnoth 1.10 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 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.