Extra tools/ru: Difference between revisions

From DDraceNetwork
Created page with "== Получение дополнительных инструментов =="
No edit summary
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
'''''Дополнительные утилиты''''' предназначены для некоторых задач, не связанных с игровым процессом, по типу оптимизации карт для мапперов, или отладки и тестирования для разработчиков. Эти утилиты должны запускаться из command-line интерфейса (вроде Командной строки в Windows или Терминала в системах на базе ядра Linux) either by adding their containing directory to the PATH variable or by running directly from the containing directory.
'''''Дополнительные утилиты''''' предназначены для некоторых задач, не связанных с игровым процессом, по типу оптимизации карт для мапперов, или отладки и тестирования для разработчиков. Эти утилиты должны запускаться из консольного интерфейса (вроде Командной строки в Windows или Терминала в системах на базе ядра Linux) либо путем добавления содержащего их каталога в системную переменную PATH, либо путем запуска непосредственно из содержащего каталога.


<span id="Getting_the_extra_tools"></span>
<span id="Getting_the_extra_tools"></span>
== Получение дополнительных инструментов ==
== Получение дополнительных утилит ==


Эти утилиты '''не''' поставляются в комплекте с бинарными файлами DDNet со [https://ddnet.org/downloads/страницы загрузки]. При этом дополнительные инструменты, связанные с картографией, можно скачать для различных платформ на странице "Загрузки" под названием "Графические инструменты".
Эти утилиты '''не''' поставляются в комплекте с бинарными файлами DDNet со [https://ddnet.org/downloads/ страницы загрузки]. При этом дополнительные инструменты, связанные с маппингом, можно скачать для различных платформ на странице "Загрузки" под названием "Графические инструменты".


<div lang="en" dir="ltr" class="mw-content-ltr">
Эти и другие дополнительные инструменты (перечисленные ниже) можно найти на [https://github.com/ddnet/ddnet GitHub] в каталоге [https://github.com/ddnet/ddnet/tree/master/src/tools src/tools].
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.
</div>


<span id="List_of_extra_tools"></span>
<span id="List_of_extra_tools"></span>
Line 20: Line 18:
  config_retrieve ''Имя_карты''
  config_retrieve ''Имя_карты''


<div lang="en" dir="ltr" class="mw-content-ltr">
Извлекает конфигурацию, встроенную в файл карты DDNet ''map_file'' и сохраняет ее в файле конфигурации карты DDNet с тем же именем (например, "Kobra 4.map" возвращает "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")
</div>


''Доступно с версии: DDNet 9.0''
''Доступно с версии: DDNet 9.0''
Line 30: Line 26:
  config_store ''Имя_Карты''
  config_store ''Имя_Карты''


<div lang="en" dir="ltr" class="mw-content-ltr">
Сохраняет конфигурацию из файла конфигурации карты в файл ''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.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Если нет разницы между конфигурацией для сохранения и конфигурацией, встроенной в карту, то операция будет отменена с сообщением <code>configs coincide, not updating map</code>.
If there is no difference between the configuration to stored and the configuration embedded in the map, then operation will be canceled with message <code>configs coincide, not updating map</code>.
</div>


''Доступно с версии: DDNet 9.0''
''Доступно с версии: DDNet 9.0''
Line 44: Line 36:
  crapnet
  crapnet


<div lang="en" dir="ltr" class="mw-content-ltr">
Проверяет соединение, устанавливая локальное соединение клиент–сервер и запуская ping между ними. Сообщает об отброшенных пакетах с сообщением <code>dropped packet</code> и об успехах с <code>cfg = "number"</code>, где "number" варьируется от 0 до 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.
</div>




Line 53: Line 43:
  dilate ''Файл_изображения1'' [''Файл_изображения2'' ... ]
  dilate ''Файл_изображения1'' [''Файл_изображения2'' ... ]


<div lang="en" dir="ltr" class="mw-content-ltr">
Это графический инструмент, в основном полезный для мапперов. Он заботится о прозрачных областях, чтобы предотвратить появление черных/белых контуров вокруг ваших изображений в игре, что позволяет избежать проблем со смешиванием и мипмапом. Более подробную информацию смотрите в [http://wiki.polycount.com/wiki/Edge_padding Edge padding].
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.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Обратите внимание, что это работает только в файлах изображений RGBA (например, PNG). В файлах JPEG это не сработает.
Note this works only in RGBA image files (e.g. PNG files). So, it will fail in e.g. JPEG files.
</div>


=== dummy_map ===
=== dummy_map ===
Line 65: Line 51:
   dummy_map
   dummy_map


<div lang="en" dir="ltr" class="mw-content-ltr">
Создает фиктивную, небольшую пустую карту, которая будет использоваться для запуска сервера. См. [https://github.com/ddnet/ddnet/blob/a66379918832e5ad93332bbe0475394b156b5c24/src/engine/shared/network_server.cpp#L371] для получения дополнительной информации.
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.
</div>


=== fake_server ===
=== fake_server ===
Line 79: Line 63:
  map_convert_07 ''путь_к_файлу_карты'' ''место_назначение_файла_карты''
  map_convert_07 ''путь_к_файлу_карты'' ''место_назначение_файла_карты''


<div lang="en" dir="ltr" class="mw-content-ltr">
Делает <code>''dest_map_file''</code> совместимым с Teeworlds версии 7.x, иначе он был бы совместим '''только''' с Teeworlds версии 6.x. В случае успеха создается действительная 07-совместимая карта назначения; в противном случае возвращается одно из следующих значений:
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:
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* Сообщение об использовании, если предоставлены неверные аргументы
* an usage message if incorrect arguments are provided
* <code>failed to open source map</code>, если при открытии карты источников произошла ошибка
* <code>failed to open source map</code> if an error happens when opening the source map
* <code>failed to open destination map</code> если при открытии карты назначения произошла ошибка
* <code>failed to open destination map</code> if an error happens when opening the destination map
* <code>error loading storage</code> если по какой-то причине не удалось открыть хранилище
* <code>error loading storage</code> if failed to open storage for some reason
* <code>failed to open image file</code> если произошла ошибка при открытии PNG-изображения
* <code>failed to open image file</code> if error happens on opening PNG image
* <code>invalid image format</code> при неправильном форматировании PNG.
* <code>invalid image format</code> if incorrectly formatted PNG.
</div>


''Доступно с версии: DDNet 12.9''
''Доступно с версии: DDNet 12.9''
Line 98: Line 78:
  map_diff ''файл_карты1'' ''файл_карты2''
  map_diff ''файл_карты1'' ''файл_карты2''


<div lang="en" dir="ltr" class="mw-content-ltr">
Сравнивает два файла карт, сообщая об одном из них:
Compares two map files, reporting one of the follow:
* нет вывода diff, что означает, что карты одинаковые
* no diff output, meaning the maps are the same
* <code>different layer numbers</code>, если одна карта имеет больше слоев, чем другая
* <code>different layer numbers</code>, if one map has more layers than another
* <code>different tile layers</code>, если количество слоев одинаково, но хотя бы один слой отличается от другого
* <code>different tile layers</code>, if the number of layers is the same, but at least one layer is different
* наконец, позиции индекса и флагов, которые отличаются.
* lastly, the index and flags positions that differ.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Если между картами нет разницы, возвращается 0; в противном случае возвращается 1.
If there is no difference between maps, returns 0; otherwise, returns 1.
</div>


=== map_extract ===
=== map_extract ===
Line 114: Line 90:
  map_extract ''файл_Карты'' [''директория'']
  map_extract ''файл_Карты'' [''директория'']


<div lang="en" dir="ltr" class="mw-content-ltr">
Извлекает содержимое из ''map_file'' в ''directory''. Если дополнительный аргумент ''директория'' не указан, извлечение производится в текущую директорию.
Extracts contents from ''map_file'' into the ''directory''. If optional argument ''directory'' is not provided, extracts to the current directory.
</div>


=== map_optimize ===
=== map_optimize ===
Line 122: Line 96:
  map_optimize ''Исходный_путь_к_файлу_карты'' [''место_назначение_файла_карты'']
  map_optimize ''Исходный_путь_к_файлу_карты'' [''место_назначение_файла_карты'']


<div lang="en" dir="ltr" class="mw-content-ltr">
Оптимизирует файл карты в указанном <code>"source_map_file path"</code> (см. [https://github.com/ddnet/ddnet/pull/3201 как это работает]) и сохраняет выходные данные в заданном <code>"dest_map_filepath"</code>; если <code>"dest_map_filepath"</code> не задан, вывод путь по умолчанию равен <code>out/"source_map_filename".map</code>, удаляя путь и расширение исходного файла.
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.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Обратите внимание, что название оптимизированных встроенных изображений изменено с <code>"originalname"</code> на <code>"originalname"_cut_"newSHA256"</code> (где <code>"newSHA256"</code> - это новый sha256 встроенного оптимизированного изображения). Он переименован для того, чтобы было ясно, что он был оптимизирован, потому что этот инструмент "будет" вносить изменения в карты, используемые файлом карты.
Note the name of the embedded images optimized is changed from <code>''originalname''</code> to <code>''originalname''_cut_''newSHA256''</code> (where <code>''newSHA256''</code> 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.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Если не удалось открыть исходный или целевой файл, возвращается -1.
If failed to open source or target file, returns -1.
</div>


''Доступно с версии: DDNet 15.5.4''
''Доступно с версии: DDNet 15.5.4''
Line 140: Line 108:
  map_replace_image ''файл_карты1'' ''файл_карты2'' ''имя_изображения'' ''файл_изображения''
  map_replace_image ''файл_карты1'' ''файл_карты2'' ''имя_изображения'' ''файл_изображения''


<div lang="en" dir="ltr" class="mw-content-ltr">
Заменяет изображение ''imagename'', находящееся в файле карты с именем ''map_file1'', на изображение с файловым путем ''image_file'' и сохраняет в файл карты с именем ''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''.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Обратите внимание:
Please note:
* Имена файлов обеих карт должны быть относительно папки DDNet по умолчанию пользователя.
* Both map filenames must be relative to user default DDNet folder
* Путь к файлу нового изображения может быть абсолютным или относительным к текущему каталогу.
* New image filepath can be absolute, or relative to the current directory
</div>


=== map_resave ===
=== map_resave ===
Line 154: Line 118:
  map_resave ''файл_карты'' ''файл_изображения''
  map_resave ''файл_карты'' ''файл_изображения''


<div lang="en" dir="ltr" class="mw-content-ltr">
Обновляет файл карты ''map_file.map'' с помощью предоставленного файла ''image_file''.
Updates the map file ''map_file.map'' with the provided file ''image_file''.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Статус ошибки 255 возвращается, если 1) предоставлено число аргументов, отличное от 2, 2) если файл ''map_file.map'' недопустим, или 3) если файл ''image_file'' не является допустимым файлом изображения (например, это текстовый файл); в противном случае возвращается 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.
</div>


=== packetgen ===
=== packetgen ===
Line 166: Line 126:
  packetgen
  packetgen


<div lang="en" dir="ltr" class="mw-content-ltr">
Генерирует и отправляет сетевые пакеты на 127.0.0.1:8303 (localhost, порт сервера по умолчанию) для проверки связи с локальным экземпляром сервера.
Generates and sends network packets to 127.0.0.1:8303 (localhost, in default server port) to test communication with a local server instance.
</div>


=== unicode_confusables ===
=== unicode_confusables ===
Line 174: Line 132:
  unicode_confusables ''строка1'' ''строка2''
  unicode_confusables ''строка1'' ''строка2''


<div lang="en" dir="ltr" class="mw-content-ltr">
Сравнивает ''string1'' со ''string2'' и сообщает, являются ли они "путаемыми", т.е. если символы "одинаковы" и могут вызвать путаницу. Чтобы это сработало, символы с акцентами или другими элементами вокруг них считаются "перепутанными" с базовым символом. Таким образом, ''aa'' и ''aá'' можно спутать ("á" считался как "a"), а ''aa'' и ''ab'' - нет.
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.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Если они перепутаны, возвращается <code>not_confusable=0</code>, в противном случае возвращается <code>not_confusable=1</code>.
If they are confusable, it returns <code>not_confusable=0</code>, otherwise, returns <code>not_confusable=1</code>.
</div>


''Доступно с версии: DDNet 10.3.5''
''Доступно с версии: DDNet 10.3.5''


<div lang="en" dir="ltr" class="mw-content-ltr">
'''Новое в DDNet версии 12.9:''' Поддержка Unicode 12.0 и название инструмента было переименовано из ''confusables'' в ''unicode_confusables''.
''New in DDNet version 12.9:'' Unicode 12.0 support and the tool name was renamed from ''confusables'' to ''unicode_confusables''.
</div>


=== uuid ===
=== uuid ===
Line 192: Line 144:
  uuid ''имя''
  uuid ''имя''


<div lang="en" dir="ltr" class="mw-content-ltr">
Выводит uuid для указанного ''имя''.
Prints uuid for the provided ''name''.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Система uuid была реализована таким образом, чтобы ее могли легко расширять независимые авторы без коллизий, чего не позволяла старая система - с возрастающими целыми числами. Это работает для сообщений движка и игры, предметов и событий снапшотов.
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.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Выходит со статусом ошибки 255, если не указано ''name''.
Exits with error status 255 if ''name'' is not provided.
</div>


''Доступно с версии: DDNet 10.6.1''
''Доступно с версии: DDNet 10.6.1''

Latest revision as of 14:51, 29 December 2023

Дополнительные утилиты предназначены для некоторых задач, не связанных с игровым процессом, по типу оптимизации карт для мапперов, или отладки и тестирования для разработчиков. Эти утилиты должны запускаться из консольного интерфейса (вроде Командной строки в Windows или Терминала в системах на базе ядра Linux) либо путем добавления содержащего их каталога в системную переменную PATH, либо путем запуска непосредственно из содержащего каталога.

Получение дополнительных утилит

Эти утилиты не поставляются в комплекте с бинарными файлами DDNet со страницы загрузки. При этом дополнительные инструменты, связанные с маппингом, можно скачать для различных платформ на странице "Загрузки" под названием "Графические инструменты".

Эти и другие дополнительные инструменты (перечисленные ниже) можно найти на GitHub в каталоге src/tools.

Список дополнительных утилит

Смотрите ниже список и описание инструментов.

config_retrieve

config_retrieve Имя_карты

Извлекает конфигурацию, встроенную в файл карты DDNet map_file и сохраняет ее в файле конфигурации карты DDNet с тем же именем (например, "Kobra 4.map" возвращает "Kobra 4.cfg").

Доступно с версии: DDNet 9.0

config_store

config_store Имя_Карты

Сохраняет конфигурацию из файла конфигурации карты в файл map_file. Оба файла конфигурации и карты должны иметь одинаковое имя в одном каталоге, иначе операция завершится неудачей.

Если нет разницы между конфигурацией для сохранения и конфигурацией, встроенной в карту, то операция будет отменена с сообщением configs coincide, not updating map.

Доступно с версии: DDNet 9.0

crapnet

crapnet

Проверяет соединение, устанавливая локальное соединение клиент–сервер и запуская ping между ними. Сообщает об отброшенных пакетах с сообщением dropped packet и об успехах с cfg = "number", где "number" варьируется от 0 до 2.


dilate

dilate Файл_изображения1 [Файл_изображения2 ... ]

Это графический инструмент, в основном полезный для мапперов. Он заботится о прозрачных областях, чтобы предотвратить появление черных/белых контуров вокруг ваших изображений в игре, что позволяет избежать проблем со смешиванием и мипмапом. Более подробную информацию смотрите в Edge padding.

Обратите внимание, что это работает только в файлах изображений RGBA (например, PNG). В файлах JPEG это не сработает.

dummy_map

 dummy_map

Создает фиктивную, небольшую пустую карту, которая будет использоваться для запуска сервера. См. [1] для получения дополнительной информации.

fake_server

fake_server

Создает фальшивый(фейковый) сервер для тестирования.

map_convert_07

map_convert_07 путь_к_файлу_карты место_назначение_файла_карты

Делает dest_map_file совместимым с Teeworlds версии 7.x, иначе он был бы совместим только с Teeworlds версии 6.x. В случае успеха создается действительная 07-совместимая карта назначения; в противном случае возвращается одно из следующих значений:

  • Сообщение об использовании, если предоставлены неверные аргументы
  • failed to open source map, если при открытии карты источников произошла ошибка
  • failed to open destination map если при открытии карты назначения произошла ошибка
  • error loading storage если по какой-то причине не удалось открыть хранилище
  • failed to open image file если произошла ошибка при открытии PNG-изображения
  • invalid image format при неправильном форматировании PNG.

Доступно с версии: DDNet 12.9

map_diff

map_diff файл_карты1 файл_карты2

Сравнивает два файла карт, сообщая об одном из них:

  • нет вывода diff, что означает, что карты одинаковые
  • different layer numbers, если одна карта имеет больше слоев, чем другая
  • different tile layers, если количество слоев одинаково, но хотя бы один слой отличается от другого
  • наконец, позиции индекса и флагов, которые отличаются.

Если между картами нет разницы, возвращается 0; в противном случае возвращается 1.

map_extract

map_extract файл_Карты [директория]

Извлекает содержимое из map_file в directory. Если дополнительный аргумент директория не указан, извлечение производится в текущую директорию.

map_optimize

map_optimize Исходный_путь_к_файлу_карты [место_назначение_файла_карты]

Оптимизирует файл карты в указанном "source_map_file path" (см. как это работает) и сохраняет выходные данные в заданном "dest_map_filepath"; если "dest_map_filepath" не задан, вывод путь по умолчанию равен out/"source_map_filename".map, удаляя путь и расширение исходного файла.

Обратите внимание, что название оптимизированных встроенных изображений изменено с "originalname" на "originalname"_cut_"newSHA256" (где "newSHA256" - это новый sha256 встроенного оптимизированного изображения). Он переименован для того, чтобы было ясно, что он был оптимизирован, потому что этот инструмент "будет" вносить изменения в карты, используемые файлом карты.

Если не удалось открыть исходный или целевой файл, возвращается -1.

Доступно с версии: DDNet 15.5.4

map_replace_image

map_replace_image файл_карты1 файл_карты2 имя_изображения файл_изображения

Заменяет изображение imagename, находящееся в файле карты с именем map_file1, на изображение с файловым путем image_file и сохраняет в файл карты с именем map_file2.map.

Обратите внимание:

  • Имена файлов обеих карт должны быть относительно папки DDNet по умолчанию пользователя.
  • Путь к файлу нового изображения может быть абсолютным или относительным к текущему каталогу.

map_resave

map_resave файл_карты файл_изображения

Обновляет файл карты map_file.map с помощью предоставленного файла image_file.

Статус ошибки 255 возвращается, если 1) предоставлено число аргументов, отличное от 2, 2) если файл map_file.map недопустим, или 3) если файл image_file не является допустимым файлом изображения (например, это текстовый файл); в противном случае возвращается 0.

packetgen

packetgen

Генерирует и отправляет сетевые пакеты на 127.0.0.1:8303 (localhost, порт сервера по умолчанию) для проверки связи с локальным экземпляром сервера.

unicode_confusables

unicode_confusables строка1 строка2

Сравнивает string1 со string2 и сообщает, являются ли они "путаемыми", т.е. если символы "одинаковы" и могут вызвать путаницу. Чтобы это сработало, символы с акцентами или другими элементами вокруг них считаются "перепутанными" с базовым символом. Таким образом, aa и можно спутать ("á" считался как "a"), а aa и ab - нет.

Если они перепутаны, возвращается not_confusable=0, в противном случае возвращается not_confusable=1.

Доступно с версии: DDNet 10.3.5

Новое в DDNet версии 12.9: Поддержка Unicode 12.0 и название инструмента было переименовано из confusables в unicode_confusables.

uuid

uuid имя

Выводит uuid для указанного имя.

Система uuid была реализована таким образом, чтобы ее могли легко расширять независимые авторы без коллизий, чего не позволяла старая система - с возрастающими целыми числами. Это работает для сообщений движка и игры, предметов и событий снапшотов.

Выходит со статусом ошибки 255, если не указано name.

Доступно с версии: DDNet 10.6.1