Extra tools/en: Difference between revisions
Updating to match new version of source page |
Updating to match new version of source page |
||
| Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
'''''Extra tools''''' are available for running some non-gaming-related tasks, like map optimization by mappers, or debugging and testing by developers. These tools must be run from command-line interface (e.g. Command Prompt on Windows or Terminal on Linux) either by adding their containing directory to the PATH variable or by running directly from the containing directory. | '''''Extra tools''''' are available for running some non-gaming-related tasks, like map optimization by mappers, or debugging and testing by developers. These tools must be run from command-line interface (e.g. Command Prompt on Windows or Terminal on Linux) either by adding their containing directory to the PATH variable or by running directly from the containing directory. | ||
== Getting the extra tools == | == Getting the extra tools == | ||
| Line 8: | Line 7: | ||
These and other extra tools (listed below) can be found on the [https://github.com/ddnet/ddnet DDNet source code] under [https://github.com/ddnet/ddnet/tree/master/src/tools src/tools] directory. | These and other extra tools (listed below) can be found on the [https://github.com/ddnet/ddnet DDNet source code] under [https://github.com/ddnet/ddnet/tree/master/src/tools src/tools] directory. | ||
== List of extra tools == | == List of extra tools == | ||
See below the list and description of the tools. | See below the list and description of the tools. | ||
=== config_retrieve === | === config_retrieve === | ||
config_retrieve ''map_file'' | |||
Retrieves configuration embedded in a DDNet map file ''map_file'' and stores it in a DDNet map configuration file with same filename (e.g. "Kobra 4.map" returns "Kobra 4.cfg") | Retrieves configuration embedded in a DDNet map file ''map_file'' and stores it in a DDNet map configuration file with same filename (e.g. "Kobra 4.map" returns "Kobra 4.cfg") | ||
''Available since: DDNet 9.0'' | ''Available since: DDNet 9.0'' | ||
=== config_store === | === config_store === | ||
config_store ''map_file'' | |||
Stores configuration from a map's configuration file into the ''map_file''. Both configuration and map files must have the same filename in the same directory, otherwise the operation will fail. | Stores configuration from a map's configuration file into the ''map_file''. Both configuration and map files must have the same filename in the same directory, otherwise the operation will fail. | ||
| Line 33: | Line 29: | ||
''Available since: DDNet 9.0'' | ''Available since: DDNet 9.0'' | ||
=== crapnet === | === crapnet === | ||
crapnet | |||
Tests connection by setting a client–server connection locally and running ping between them. Reports dropped packets with message <code>dropped packet</code> and successes with <code>cfg = ''number''</code>, where ''number'' varies from 0 to 2. | Tests connection by setting a client–server connection locally and running ping between them. Reports dropped packets with message <code>dropped packet</code> and successes with <code>cfg = ''number''</code>, where ''number'' varies from 0 to 2. | ||
| Line 44: | Line 39: | ||
=== dilate === | === dilate === | ||
dilate ''image_file1'' [''image_file2'' ... ] | |||
It is a graphics tool, mainly useful for mappers. It takes care of transparent areas to prevent black/white outlines around your images ingame, therefore avoiding blending and mipmap issues. See [http://wiki.polycount.com/wiki/Edge_padding Edge padding] for more info. | It is a graphics tool, mainly useful for mappers. It takes care of transparent areas to prevent black/white outlines around your images ingame, therefore avoiding blending and mipmap issues. See [http://wiki.polycount.com/wiki/Edge_padding Edge padding] for more info. | ||
Note this works only in RGBA image files (e.g. PNG files). So, it will fail in e.g. JPEG files. | Note this works only in RGBA image files (e.g. PNG files). So, it will fail in e.g. JPEG files. | ||
=== dummy_map === | === dummy_map === | ||
| Line 56: | Line 50: | ||
Creates a dummy, small empty map to be used to start a server. See [https://github.com/ddnet/ddnet/blob/a66379918832e5ad93332bbe0475394b156b5c24/src/engine/shared/network_server.cpp#L371] for more info. | Creates a dummy, small empty map to be used to start a server. See [https://github.com/ddnet/ddnet/blob/a66379918832e5ad93332bbe0475394b156b5c24/src/engine/shared/network_server.cpp#L371] for more info. | ||
=== fake_server === | === fake_server === | ||
fake_server | |||
Creates a fake server for testing. | Creates a fake server for testing. | ||
=== map_convert_07 === | === map_convert_07 === | ||
map_convert_07 ''src_map_file'' ''dest_map_file'' | |||
Makes <code>''dest_map_file''</code> compatible with Teeworlds version 7.x that otherwise it would be compatible '''only''' with Teeworlds version 6.x. If successfully, it creates a valid 07-compatible destination map; otherwise, it returns one of the following: | Makes <code>''dest_map_file''</code> compatible with Teeworlds version 7.x that otherwise it would be compatible '''only''' with Teeworlds version 6.x. If successfully, it creates a valid 07-compatible destination map; otherwise, it returns one of the following: | ||
| Line 79: | Line 71: | ||
''Available since: DDNet 12.9'' | ''Available since: DDNet 12.9'' | ||
=== map_diff === | === map_diff === | ||
map_diff ''map_file1'' ''map_file2'' | |||
Compares two map files, reporting one of the follow: | Compares two map files, reporting one of the follow: | ||
| Line 92: | Line 83: | ||
If there is no difference between maps, returns 0; otherwise, returns 1. | If there is no difference between maps, returns 0; otherwise, returns 1. | ||
=== map_extract === | === map_extract === | ||
map_extract ''map_file'' [''directory''] | |||
Extracts contents from ''map_file'' into the ''directory''. If optional argument ''directory'' is not provided, extracts to the current directory. | Extracts contents from ''map_file'' into the ''directory''. If optional argument ''directory'' is not provided, extracts to the current directory. | ||
=== map_optimize === | === map_optimize === | ||
map_optimize ''source_map_filepath'' [''dest_map_filepath''] | |||
Optimizes the map file in the <code>''source_map_filepath''</code> given (see [https://github.com/ddnet/ddnet/pull/3201 how it works]) and stores the output in the given <code>''dest_map_filepath''</code>; if <code>''dest_map_filepath''</code> is unset, output path defaults to <code>out/''source_map_filename''.map</code>, stripping the path and the extension of the source file. | Optimizes the map file in the <code>''source_map_filepath''</code> given (see [https://github.com/ddnet/ddnet/pull/3201 how it works]) and stores the output in the given <code>''dest_map_filepath''</code>; if <code>''dest_map_filepath''</code> is unset, output path defaults to <code>out/''source_map_filename''.map</code>, stripping the path and the extension of the source file. | ||
| Line 112: | Line 101: | ||
''Available since:'' DDNet 15.5.4 | ''Available since:'' DDNet 15.5.4 | ||
=== map_replace_image === | === map_replace_image === | ||
map_replace_image ''map_file1'' ''map_file2'' ''imagename'' ''image_file'' | |||
Replaces the image ''imagename'' currently inside the map filename ''map_file1'' with the image filepath ''image_file'', and save into the map filename ''map_file2.map''. | Replaces the image ''imagename'' currently inside the map filename ''map_file1'' with the image filepath ''image_file'', and save into the map filename ''map_file2.map''. | ||
| Line 123: | Line 111: | ||
* Both map filenames must be relative to user default DDNet folder | * Both map filenames must be relative to user default DDNet folder | ||
* New image filepath can be absolute, or relative to the current directory | * New image filepath can be absolute, or relative to the current directory | ||
=== map_resave === | === map_resave === | ||
map_resave ''map_file'' ''image_file'' | |||
Updates the map file ''map_file.map'' with the provided file ''image_file''. | Updates the map file ''map_file.map'' with the provided file ''image_file''. | ||
The error status 255 is returned if 1) a number of arguments different from 2 is provided, 2) if the ''map_file.map'' is not valid, or 3) if ''image_file'' is not a valid image file (e.g. it is a text file); otherwise, return 0. | The error status 255 is returned if 1) a number of arguments different from 2 is provided, 2) if the ''map_file.map'' is not valid, or 3) if ''image_file'' is not a valid image file (e.g. it is a text file); otherwise, return 0. | ||
=== packetgen === | === packetgen === | ||
packetgen | |||
Generates and sends network packets to 127.0.0.1:8303 (localhost, in default server port) to test communication with a local server instance. | Generates and sends network packets to 127.0.0.1:8303 (localhost, in default server port) to test communication with a local server instance. | ||
=== unicode_confusables === | === unicode_confusables === | ||
unicode_confusables ''string1'' ''string2'' | |||
Compares ''string1'' with ''string2'' and report if they are "confusable", i.e. if the characters are "equal" and could cause confusion. For this to work, the characters with accents or other things around them are considered the "confusable" with the base character. Therefore, ''aa'' and ''aá'' are confusable (''á'' was considered as ''a''), while ''aa'' and ''ab'' are not. | Compares ''string1'' with ''string2'' and report if they are "confusable", i.e. if the characters are "equal" and could cause confusion. For this to work, the characters with accents or other things around them are considered the "confusable" with the base character. Therefore, ''aa'' and ''aá'' are confusable (''á'' was considered as ''a''), while ''aa'' and ''ab'' are not. | ||
| Line 152: | Line 137: | ||
''New in DDNet version 12.9:'' Unicode 12.0 support and the tool name was renamed from ''confusables'' to ''unicode_confusables''. | ''New in DDNet version 12.9:'' Unicode 12.0 support and the tool name was renamed from ''confusables'' to ''unicode_confusables''. | ||
=== uuid === | === uuid === | ||
uuid ''name'' | |||
Prints uuid for the provided ''name''. | Prints uuid for the provided ''name''. | ||
Latest revision as of 16:47, 13 March 2023
Extra tools are available for running some non-gaming-related tasks, like map optimization by mappers, or debugging and testing by developers. These tools must be run from command-line interface (e.g. Command Prompt on Windows or Terminal on Linux) either by adding their containing directory to the PATH variable or by running directly from the containing directory.
Getting the extra tools
These tools are not provided in the binary DDNet game in the Downloads page. Having that said, extra tools mapping-related can be download for different platforms in the Downloads page, under the name "Graphics Tools".
These and other extra tools (listed below) can be found on the DDNet source code under src/tools directory.
List of extra tools
See below the list and description of the tools.
config_retrieve
config_retrieve map_file
Retrieves configuration embedded in a DDNet map file map_file and stores it in a DDNet map configuration file with same filename (e.g. "Kobra 4.map" returns "Kobra 4.cfg")
Available since: DDNet 9.0
config_store
config_store map_file
Stores configuration from a map's configuration file into the map_file. Both configuration and map files must have the same filename in the same directory, otherwise the operation will fail.
If there is no difference between the configuration to stored and the configuration embedded in the map, then operation will be canceled with message configs coincide, not updating map.
Available since: DDNet 9.0
crapnet
crapnet
Tests connection by setting a client–server connection locally and running ping between them. Reports dropped packets with message dropped packet and successes with cfg = number, where number varies from 0 to 2.
dilate
dilate image_file1 [image_file2 ... ]
It is a graphics tool, mainly useful for mappers. It takes care of transparent areas to prevent black/white outlines around your images ingame, therefore avoiding blending and mipmap issues. See Edge padding for more info.
Note this works only in RGBA image files (e.g. PNG files). So, it will fail in e.g. JPEG files.
dummy_map
dummy_map
Creates a dummy, small empty map to be used to start a server. See [1] for more info.
fake_server
fake_server
Creates a fake server for testing.
map_convert_07
map_convert_07 src_map_file dest_map_file
Makes dest_map_file compatible with Teeworlds version 7.x that otherwise it would be compatible only with Teeworlds version 6.x. If successfully, it creates a valid 07-compatible destination map; otherwise, it returns one of the following:
- an usage message if incorrect arguments are provided
failed to open source mapif an error happens when opening the source mapfailed to open destination mapif an error happens when opening the destination maperror loading storageif failed to open storage for some reasonfailed to open image fileif error happens on opening PNG imageinvalid image formatif incorrectly formatted PNG.
Available since: DDNet 12.9
map_diff
map_diff map_file1 map_file2
Compares two map files, reporting one of the follow:
- no diff output, meaning the maps are the same
different layer numbers, if one map has more layers than anotherdifferent tile layers, if the number of layers is the same, but at least one layer is different- lastly, the index and flags positions that differ.
If there is no difference between maps, returns 0; otherwise, returns 1.
map_extract
map_extract map_file [directory]
Extracts contents from map_file into the directory. If optional argument directory is not provided, extracts to the current directory.
map_optimize
map_optimize source_map_filepath [dest_map_filepath]
Optimizes the map file in the source_map_filepath given (see how it works) and stores the output in the given dest_map_filepath; if dest_map_filepath is unset, output path defaults to out/source_map_filename.map, stripping the path and the extension of the source file.
Note the name of the embedded images optimized is changed from originalname to originalname_cut_newSHA256 (where newSHA256 is the new sha256 of the embedded optimized image). It is renamed is to make clear it was optimized because this tool will make changes in the mapres used by the map file.
If failed to open source or target file, returns -1.
Available since: DDNet 15.5.4
map_replace_image
map_replace_image map_file1 map_file2 imagename image_file
Replaces the image imagename currently inside the map filename map_file1 with the image filepath image_file, and save into the map filename map_file2.map.
Please note:
- Both map filenames must be relative to user default DDNet folder
- New image filepath can be absolute, or relative to the current directory
map_resave
map_resave map_file image_file
Updates the map file map_file.map with the provided file image_file.
The error status 255 is returned if 1) a number of arguments different from 2 is provided, 2) if the map_file.map is not valid, or 3) if image_file is not a valid image file (e.g. it is a text file); otherwise, return 0.
packetgen
packetgen
Generates and sends network packets to 127.0.0.1:8303 (localhost, in default server port) to test communication with a local server instance.
unicode_confusables
unicode_confusables string1 string2
Compares string1 with string2 and report if they are "confusable", i.e. if the characters are "equal" and could cause confusion. For this to work, the characters with accents or other things around them are considered the "confusable" with the base character. Therefore, aa and aá are confusable (á was considered as a), while aa and ab are not.
If they are confusable, it returns not_confusable=0, otherwise, returns not_confusable=1.
Available since: DDNet version 10.3.5
New in DDNet version 12.9: Unicode 12.0 support and the tool name was renamed from confusables to unicode_confusables.
uuid
uuid name
Prints uuid for the provided name.
The uuid system was implemented to be easily extended by independent authors without collisions, something that the old system – with increasing integers – did not allow. This works for engine and game messages, snapshot items and events.
Exits with error status 255 if name is not provided.
Available since: DDNet 10.6.1