Template:BeginFileFormatTools

From ModdingWiki
Jump to navigation Jump to search

This is the table heading for a list of file format tools.

Examples

Type=archive

This type is used for game archives. These are similar to .zip files in that they store a collection of other files, usually with filenames and sometimes with compression. A key point of an archive is that it can store arbitrary data, so tilesets are usually not considered archives as they cannot store non-image data like game maps or sound effects.

This used to be type=group, however it has now changed to type=archive. Please update if you see any old type=group uses.

The following tools are able to work with files in this format.

Name PlatformExtract files? Decompress on extract? Create new? Modify? Compress on insert? Access hidden data? Edit metadata? Notes
Example DOSYesN/AYesNoN/AView onlyOnly title Example entry
{{BeginFileFormatTools|Type=archive}}
{{FileFormatTool
| Name = Example
| Platform = DOS
| canExtract = Yes
| canDecompress = N/A
| canCreate = Yes
| canModify = No
| canCompress = N/A
| editHidden = View only
| editMetadata = Only title
| notes = Example entry
}}
{{EndFileFormatTools}}
Parameter/example Meaning
canExtract = Yes Can this program extract files from the archive?
  • Yes: this program can extract files from the game's archive files
  • Partial: this program can extract some files (but not all) from the game's archive files
  • No: this program cannot extract any files from the game's archive files
canDecompress = N/A Can this program decompress files it extracts? (if supported by the format)
  • Yes: this program can decompress all files from the game's archive files
  • Partial: this program can decompress some files (but not all) from the game's archive files
  • No: this program cannot decompress any files from the game's archive files
  • N/A: none of the archive files support compression
canDecrypt = Yes Can this program decrypt files it extracts? (if supported by the format, must add Encrypt=yes to {{BeginFileFormatTools}})
canCreate = No Can this program create new files in this format from scratch?
canModify = Yes Can this program modify parts of the file, leaving the rest unchanged?
canCompress = Yes Can this program compress files, if the group file supports compression?
canEncrypt = Yes Can this program encrypt files it inserts? (if supported by the format, must add Encrypt=yes to {{BeginFileFormatTools}})
editHidden = [Edit|Read|No|N/A] Can this program view/edit hidden data inside the file? (if supported by the format)
  • Edit: hidden data can be read and modified
  • Read: hidden data can be viewed/extracted but not changed or set
  • No: hidden data cannot be viewed or changed
  • N/A: this file format does not have anywhere to embed any hidden data
editMetadata = [Edit|Read|No|N/A] Can this program view/edit any metadata? (e.g. file description, title, artist, etc.)
  • Edit: all known metadata can be read and modified
  • Partial: some metadata can be read and/or modified
  • Read: all metadata can be viewed/extracted but not changed or set
  • No: none of the metadata can be viewed or changed
  • N/A: this file format does not have any metadata
notes = text Various notes, try to keep as short as possible

Type=audio

This type is used for sound effects (as opposed to music). Typically digitised audio like .wav files, but can also include OPL and PC speaker sound effects as well.

The following tools are able to work with files in this format.

Name PlatformPlay? Create new? Modify? Convert/export to other? Import from other? Access hidden data? Edit metadata? Notes
Name DOSYesYesNoNoYes; .wavN/APartial notes
{{BeginFileFormatTools|Type=audio}}
{{FileFormatTool
| Name = Name
| Platform = DOS
| canPlay = Yes
| canCreate = Yes
| canModify = No
| canExport = No
| canImport = Yes; .wav
| editHidden = N/A
| editMetadata = Partial
| notes = notes
}}
{{EndFileFormatTools}}
Parameter/example Meaning
canPlay = Yes Can this program play audio in this format?
  • Yes: this program can play all files in this format
  • Partial: this program can play some files (but not all) in this format
  • No: this program cannot play any files in this format (e.g. it is a conversion utility not a player)
canCreate = No Can this program create new files in this format from scratch?
  • Yes: this program can create empty files in this format
  • No: this program cannot create empty files in this format
canModify = Yes Can this program modify parts of the file, leaving the rest unchanged?
  • Yes: this program can modify all files in this format
  • Partial: this program can modify parts of files but there are some parts it cannot change
  • No: this program cannot modify any files in this format
canExport = Yes; .wav Can this program export the image into another format?
  • Yes: this program can convert this file format to the ones listed
  • No: this program cannot convert this file format to a different format
canImport = Yes; .wav Can this program import another image into this format?
  • Yes: this program can read the listed formats and convert them to this file format
  • No: this program cannot convert any other file formats into this format
editHidden = [Edit|Read|No|N/A] Can this program view/edit hidden data inside the file? (if supported by the format)
  • Edit: hidden data can be read and modified
  • Read: hidden data can be viewed/extracted but not changed or set
  • No: hidden data cannot be viewed or changed
  • N/A: this file format does not have anywhere to embed any hidden data
editMetadata = [Edit|Read|No|N/A] Can this program view/edit group file metadata? (e.g. file description, title, artist, etc.)
  • Edit: all known metadata can be read and modified
  • Partial: some metadata can be read and/or modified
  • Read: all metadata can be viewed/extracted but not changed or set
  • No: none of the metadata can be viewed or changed
  • N/A: this file format does not have any metadata
notes = text Various notes, try to keep as short as possible

Type=exe

This type is used for tools that can edit executable files, to patch code, change messages, and alter other hard-coded game attributes.

The following tools are able to work with files in this format.

Name PlatformLoad? Decompress? Create? Modify? Compress? Access hidden data? Notes
Name PlatformYesNoNoPartialNoN/A notes
{{BeginFileFormatTools|Type=exe}}
{{FileFormatTool
| Name = Name
| Platform = Platform
| canView = Yes
| canDecompress = No
| canCreate = No
| canModify = Partial
| canCompress = No
| editHidden = N/A
| notes = notes
}}
{{EndFileFormatTools}}
Parameter/example Meaning
canView = Yes Can this program view code or patches previously applied to the code?
  • Yes: this program can view code or patches
  • Partial: this program has some incomplete functionality for viewing code or patches
  • No: this program cannot view any code or patches
canDecompress = N/A Can this program decompress/decrypt executable files?
  • Yes: this program can decompress all executable files in this format
  • Partial: this program can partially decompress some files (but not all) in this format
  • No: this program cannot decompress any executable files in this format
canCreate = No Can this program create new files in this format from scratch?
canModify = Yes Can this program modify parts of the file, leaving the rest unchanged?
canCompress = Yes Can this program compress/encrypt files?
  • Yes: this program can compress all executable files in this format
  • Partial: this program can partially compress some files (but not all) in this format
  • No: this program cannot compress any executable files in this format
editHidden = [Edit|Read|No|N/A] Can this program view/edit hidden data inside the file? (if supported by the format)
  • Edit: hidden data can be read and modified
  • Read: hidden data can be viewed/extracted but not changed or set
  • No: hidden data cannot be viewed or changed
  • N/A: this file format does not have anywhere to embed any hidden data
notes = text Various notes, try to keep as short as possible

Type=game

This type is used on a game page rather than a file format page, and lists tools with respect to the general areas of the game it can edit.

General programs (such as .wav file editors) are not listed here, as the focus is on editors specific to the game itself. However some general programs may be included if their focus is on game-specific file formats, such as IMF Format which is not used outside of a few of games. If this list grows to be too great (e.g. there are dozens of programs capable of editing .IMF files, so listing all of them on every game using that file format will clutter the results), then a link to the file format page should be placed below the template instead, and all the tools listed once on the file format page instead.

The following tools are able to work with this game.

Name PlatformGroup/archives Levels Graphics Music Sounds Text Saves .exe patch Notes
Name PlatformEditNoReadNoNoPartialN/ANo notes
{{BeginFileFormatTools|Type=game}}
{{FileFormatTool
| Name = Name
| Platform = Platform
| grp = Edit
| map = No
| gfx = Read
| mus = No
| sfx = No
| txt = Partial
| sav = N/A
| exe = No
| notes = notes
}}
{{EndFileFormatTools}}
Parameter/example Meaning
grp = [Edit|Read|No|N/A] Can this program edit game archives/group files?
  • Edit: this program can read and change all the game's archive files
  • Read: this program can read/extract the game's archives, but it cannot modify them or create them from scratch
  • No: this program cannot do anything with the game's archive files
  • N/A: this game does not have any archive files
map = [Edit|Read|No|N/A] Can this program edit maps/levels?
  • Edit: this program can read and change all the game's levels
  • Read: this program can view the game's levels, but it cannot modify them or create them from scratch
  • No: this program cannot do anything with the game's levels
  • N/A: this game does not have any levels/maps
gfx = [Edit|Read|No|N/A] Can this program edit the game's graphics?
  • Edit: this program can read and change all the game's graphics
  • Read: this program can read/extract the game's graphics, but it cannot modify them or create them from scratch
  • No: this program cannot do anything with the game's graphics
  • N/A: this game does not have any graphics
mus = [Edit|Read|No|N/A] Can this program edit the game's music?
  • Edit: this program can read/extract/convert/play and also modify all the game's music
  • Read: this program can read/extract/convert/play the game's music, but it cannot replace it or change it
  • No: this program cannot do anything with the game's music
  • N/A: this game does not have any music
sfx = [Edit|Read|No|N/A] Can this program edit the game's sound effects?
  • Edit: this program can read/extract/convert/play and also modify all the game's sound effects
  • Read: this program can read/extract/convert/play the game's sound effects, but it cannot replace it or change any of them
  • No: this program cannot do anything with the game's sound effects
  • N/A: this game does not have any sound effects
txt = [Edit|Read|No|N/A] Can this program edit text messages displayed in the game?
  • Edit: this program can view and also modify all the game's textual data
  • Read: this program can view the game's textual data, but it cannot replace it or change any of it
  • No: this program cannot do anything with the game's textual data
  • N/A: this game does not have any text
sav = [Edit|Read|No|N/A] Can this program alter saved games?
  • Edit: this program can view and also modify saved game files
  • Read: this program can view saved game files, but it cannot modify them
  • No: this program cannot do anything with the saved game files
  • N/A: this game does not have any saved game files
exe = [Edit|Read|No] Can this program patch the game's code to change e.g. enemy behaviour?
  • Edit: this program can patch the game's code
  • Read: this program can view elements of the game's code, but it cannot modify anything
  • No: this program cannot do anything with the game's code
editHidden = [Edit|Read|No|N/A] Can this program view/edit hidden data inside the file? (if supported by the format)
  • Edit: hidden data can be read and modified
  • Read: hidden data can be viewed/extracted but not changed or set
  • No: hidden data cannot be viewed or changed
  • N/A: this game does not have anywhere to embed any hidden data
editMetadata = [Edit|Read|No|N/A] Can this program view/edit group file metadata? (e.g. file description, title, artist, etc.)
  • Edit: all known metadata can be read and modified
  • Partial: some metadata can be read and/or modified
  • Read: all metadata can be viewed/extracted but not changed or set
  • No: none of the metadata can be viewed or changed
  • N/A: this game does not have any metadata
notes = text Various notes, try to keep as short as possible

Type=image

This type is used for any sort of graphics data, including images, animations and tilesets.

The following tools are able to work with files in this format.

Name PlatformView images in this format? Convert/export to another file/format? Import from another file/format? Access hidden data? Edit metadata? Notes
Name Linux/Mac/WindowsYesNoYes; .pngN/APartial notes
{{BeginFileFormatTools|Type=image}}
{{FileFormatTool
| Name = Name
| Platform = Linux/Mac/Windows
| canView = Yes
| canExport = No
| canImport = Yes; .png
| editHidden = N/A
| editMetadata = Partial
| notes = notes
}}
{{EndFileFormatTools}}
Parameter/example Meaning
canView = Yes Can this program view the image?
  • Yes: this program can view all files in this format
  • Partial: this program can view some files (but not all) in this format
  • No: this program cannot view any files in this format (e.g. it is a conversion utility not a viewer)
canExport = Yes; .wav Can this program export the image into another format?
  • Yes: this program can convert this file format to the ones listed
  • No: this program cannot convert this file format to a different format
canImport = Yes; .wav Can this program import another image into this format?
  • Yes: this program can read the listed formats and convert them to this file format
  • No: this program cannot convert any other file formats into this format
editHidden = [Edit|Read|No|N/A] Can this program view/edit hidden data inside the file? (if supported by the format)
  • Edit: hidden data can be read and modified
  • Read: hidden data can be viewed/extracted but not changed or set
  • No: hidden data cannot be viewed or changed
  • N/A: this file format does not have anywhere to embed any hidden data
editMetadata = [Edit|Read|No|N/A] Can this program view/edit group file metadata? (e.g. file description, title, artist, etc.)
  • Edit: all known metadata can be read and modified
  • Partial: some metadata can be read and/or modified
  • Read: all metadata can be viewed/extracted but not changed or set
  • No: none of the metadata can be viewed or changed
  • N/A: this file format does not have any metadata
notes = text Various notes, try to keep as short as possible

Type=map

This type is used for tools that can edit game levels.

The following tools are able to work with files in this format.

Name PlatformView? Create new? Modify? Access hidden data? Edit metadata? Notes
Name DOSYesNoPartialN/AN/A notes
{{BeginFileFormatTools|Type=map}}
{{FileFormatTool
| Name = Name
| Platform = DOS
| canView = Yes
| canCreate = No
| canModify = Partial
| editHidden = N/A
| editMetadata = N/A
| notes = notes
}}
{{EndFileFormatTools}}
Parameter/example Meaning
canView = Yes Can this program view/render the map? (to the screen or to an image file)
  • Yes: this program can view all files in this format
  • Partial: this program can view some files (but not all) in this format
  • No: this program cannot view any files in this format (e.g. it is a conversion utility not a viewer)
canCreate = No Can this program create new files in this format from scratch?
  • Yes: this program can create empty files in this format
  • No: this program cannot create empty files in this format
canModify = Yes Can this program modify parts of the file, leaving the rest unchanged?
  • Yes: this program can modify all files in this format
  • Partial: this program can modify parts of files but there are some parts it cannot change
  • No: this program cannot modify any files in this format
editHidden = [Edit|Read|No|N/A] Can this program view/edit hidden data inside the file? (if supported by the format)
  • Edit: hidden data can be read and modified
  • Read: hidden data can be viewed/extracted but not changed or set
  • No: hidden data cannot be viewed or changed
  • N/A: this file format does not have anywhere to embed any hidden data
editMetadata = [Edit|Read|No|N/A] Can this program view/edit group file metadata? (e.g. file description, title, artist, etc.)
  • Edit: all known metadata can be read and modified
  • Partial: some metadata can be read and/or modified
  • Read: all metadata can be viewed/extracted but not changed or set
  • No: none of the metadata can be viewed or changed
  • N/A: this file format does not have any metadata
notes = text Various notes, try to keep as short as possible

Type=text

This type is used for text files, such as scripts, plain text configuration files, etc.

The following tools are able to work with files in this format.

Name PlatformView? Modify? Access hidden data? Edit metadata? Notes
Name DOSYesPartialN/AN/A notes
{{BeginFileFormatTools|Type=text}}
{{FileFormatTool
| Name = Name
| Platform = DOS
| canView = Yes
| canModify = Partial
| editHidden = N/A
| editMetadata = N/A
| notes = notes
}}
{{EndFileFormatTools}}
Parameter/example Meaning
canView = Yes Can this program view the text?
  • Yes: this program can view all files in this format
  • Partial: this program can view some files (but not all) in this format
  • No: this program cannot view any files in this format
canModify = Yes Can this program modify parts of the file, leaving the rest unchanged?
  • Yes: this program can modify all files in this format
  • Partial: this program can modify parts of files but there are some parts it cannot change
  • No: this program cannot modify any files in this format
editHidden = [Edit|Read|No|N/A] Can this program view/edit hidden data inside the file? (if supported by the format)
  • Edit: hidden data can be read and modified
  • Read: hidden data can be viewed/extracted but not changed or set
  • No: hidden data cannot be viewed or changed
  • N/A: this file format does not have anywhere to embed any hidden data
editMetadata = [Edit|Read|No|N/A] Can this program view/edit group file metadata? (e.g. file description, title, artist, etc.)
  • Edit: all known metadata can be read and modified
  • Partial: some metadata can be read and/or modified
  • Read: all metadata can be viewed/extracted but not changed or set
  • No: none of the metadata can be viewed or changed
  • N/A: this file format does not have any metadata
notes = text Various notes, try to keep as short as possible