View source for Development/ru

{{MigrateTranslation}}
<languages/>
Цель этой статьи - познакомить вас с DDNet '''''разработкой''''', поскольку это игра с открытым исходным кодом, она полагается на случайных людей, готовых внести в нее свой вклад в свободное время.


<span id="Your_development_environment"></span>
== Ваша среда разработки ==

Крайне рекомендуется установить среду Linux для начала программирования в DDNet по следующим причинам (на данный момент):
* Большинство участников DDNet на самом деле используют Linux для внесения вклада.
* Более простое управление пакетами, вы можете легко установить все необходимые библиотеки и начать вносить свой вклад.
* Эта статья пока не имеет версии для Windows и ориентирована на Linux.

Прежде всего, DDNet написан с использованием языка программирования C++, вам необходимо быть достаточно знакомым с ним, но вы также можете знать основы и научиться большему с его помощью.

Некоторые полезные ресурсы для изучения C++:
* [https://www.learncpp.com/ learncpp.com]
* [https://en.cppreference.com/w/ cppreference.com]
* Предпочтительная поисковая система

Исходный код DDNet управляется с помощью [https://git-scm.com/ Git], системы контроля версий, важного инструмента для совместной работы с несколькими разработчиками.

Если в вашем дистрибутиве Linux еще нет git, обязательно установите его, например, в большинстве дистрибутивов на базе debian/ubuntu: <code>sudo apt install git</code>.


<span id="Getting_the_source_code"></span>
== Получение исходного кода ==

Исходный код находится на [https://github.com/ddnet/ddnet Github], вы можете получить исходный код путем клонирования без необходимости иметь учетную запись, но если вы хотите когда-либо внести свои изменения в официальный исходный код, то она вам понадобится.

Если вы не знакомы с git/github, вы можете изучить основы здесь: [https://docs.github.com/en/get-started/quickstart/hello-world Hello World - Github].


<span id="Installing_the_dependencies"></span>
== Установка зависимостей ==

Если вы работаете на Linux, вы можете установить все необходимые зависимости, прочитав README на странице DDNet на github: https://github.com/ddnet/ddnet#dependencies-on-linux--macos.

Для Arch Linux:

<syntaxhighlight lang="bash">
sudo pacman -S --needed base-devel cmake curl ffmpeg freetype2 git glew glslang gmock libnotify libpng opusfile python rust sdl2 spirv-tools sqlite vulkan-headers vulkan-icd-loader wavpack x264
</syntaxhighlight>

Для Debian:

<syntaxhighlight lang="bash">
sudo apt install build-essential cargo cmake git glslang-tools google-mock libavcodec-extra libavdevice-dev libavfilter-dev libavformat-dev libavutil-dev libcurl4-openssl-dev libfreetype6-dev libglew-dev libnotify-dev libogg-dev libopus-dev libopusfile-dev libpng-dev libsdl2-dev libsqlite3-dev libssl-dev libvulkan-dev libwavpack-dev libx264-dev python rustc spirv-tools4
</syntaxhighlight>

<span id="Compiling_DDNet"></span>
== Компиляция DDNet ==

Мы используем CMake для управления процессом компиляции, если у вас установлены все зависимости, это так же просто, как выполнить следующие команды (убедитесь, что вы находитесь в папке DDNet):

<syntaxhighlight lang="bash">
mkdir build
cd build
cmake ..
make -j$(nproc)
</syntaxhighlight>


<span id="General_information"></span>
== Общая информация ==

Вот некоторые общие сведения:
* В настоящее время исходный код скомпилирован в соответствии со стандартом C++17, но вы увидите, что многие части кода больше похожи на C, поскольку только в основном новый код использует материал C++17.
* <code>std::string</code> используется редко, массивы символов плюс использование <code>system.h</code> методы для их обработки являются нормой.
* Большая часть кода ввода-вывода, форматирования и печати выполняется с использованием методов, предоставляемых system.h</code>.


<span id="The_source_code_layout"></span>
== Расположение исходного кода ==

Теперь, когда вы можете собрать DDNet, вы можете приступить к его редактированию.


<span id="The_src/base_directory"></span>
=== Каталог src/base ===

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


<span id="The_src/engine_directory"></span>
=== Каталог src/engine ===

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


<span id="The_src/game_directory"></span>
=== Каталог src/game ===

Весь код, связанный с геймплеем, находится здесь, разделенный на клиентский и серверный.


<span id="Server_side"></span>
==== Серверная сторона ====

Эта игра использует свою собственную иерархическую объектно-ориентированную систему сущностей, основным классом, от которого происходят все остальные сущности, является <code>CEntity</code> located in <code>src/game/server/entity.h</code>.

Эти сущности управляются игровым миром, расположенным здесь <code>src/game/server/gameworld.h</code>.

К числу важных структур относятся:

* [https://github.com/ddnet/ddnet/blob/master/src/game/server/entities/character.h CCharacter]: Представляет собой [[Special:MyLanguage/Common_Terminology#Tee|тии]], который является живым, он создается при порождении тии и удаляется при его смерти. Информацию о том, как игрок сохраняется между смертями, см. в [https://github.com/ddnet/ddnet/blob/master/src/game/server/player.h CPlayer].


<span id="Client_side"></span>
==== Клиентская сторона ====

Клиентская сторона состоит из компонентов, это классы, которые наследуют <code>CComponent</code>: Эти компоненты могут реализовывать виртуальные методы, такие как <code>OnInit</code>, <code>OnMessage</code> и т.д., чтобы обеспечить их функциональность.


<span id="Networking"></span>
==== Сетевое взаимодействие ====

Сетевой протокол в основном генерируется скриптами python, которые выводят код C++, например, <code>datasrc/network.py</code> определяет все сетевые пакеты.


<span id="Code_conventions"></span>
== Кодовые конвенции ==

Продолжающаяся дискуссия о кодовых соглашениях находится здесь: [https://github.com/ddnet/ddnet/issues/2945 ddnet#2945].

В настоящее время применяется следующее:


<span id="Indentation_style"></span>
=== Indentation стиль ===

[https://en.wikipedia.org/wiki/Indentation_style#Allman_style Allman style] используется.

<blockquote>
Этот стиль помещает скобку, связанную с управляющим оператором, на следующую строку с отступом на том же уровне, что и управляющий оператор. Утверждения внутри скобок отступают на следующий уровень.
</blockquote>

<syntaxhighlight lang="cpp">
while(x == y)
{
    Something();
    SomethingElse();
}

FinalThing();
</syntaxhighlight>

<span id="Classes_and_Structs"></span>
=== Классы и структуры ===

Должен иметь префикс <code>C</code> (по устаревшим причинам это игнорируется для структур в некоторых местах, например, в графическом коде) или <code>I</code> для интерфейсов. Новая структуры должны иметь префикс <code>S</code>.

Пример:

<syntaxhighlight lang="cpp">
class CCharacter : public CEntity
{
    // ...
}
</syntaxhighlight>


<span id="Enums_and_constants"></span>
=== Перечисления и константы ===

Должен быть screaming snake case, например: <code>MAX_PLAYERS</code>

<syntaxhighlight lang="cpp">
enum
{
	FAKETUNE_FREEZE = 1,
	FAKETUNE_SOLO = 2,
	FAKETUNE_NOJUMP = 4,
	FAKETUNE_NOCOLL = 8,
	FAKETUNE_NOHOOK = 16,
	FAKETUNE_JETPACK = 32,
	FAKETUNE_NOHAMMER = 64,
};
</syntaxhighlight>


<span id="Variable_naming"></span>
=== Именование переменных ===

* Имена переменных содержат 3 части: классификатор, префикс и имя.
* Имена переменных должны начинаться с прописной буквы, если только они не имеют длину в 1 символ без какого-либо префикса или определителя, например: <code>i</code>, <code>x</code>, <code>y</code>.
* Переменные могут иметь более 1 классификатора (или нуля) и более 1 префикса (или нуля).

Они расположены следующим образом: <code>[qualifiers]_[prefixes][Name]</code>


<span id="Qualifiers"></span>
==== Классификаторы ====

* <code>m</code> для переменных-членов: <code>m_MyVariable</code>.
* <code>s</code> для статических переменных: <code>s_MyStaticVariable</code>, <code>ms_MyStaticMemberVariable</code>.
* <code>g</code> для глобальных переменных с внешней связью: <code>gs_MyGlobalStaticVar</code>.


<span id="Prefixes"></span>
==== Префиксы ====

* <code>p</code> для указателей: <code>pMyPointer</code>, <code>m_pCharacter</code>, <code>ppMyPointerToPointer</code>.
* <code>a</code> для массивов: <code>aMyArray</code>, <code>aBuf</code>.
* <code>v</code> для <code>std::vector</code>s: <code>vMyVector</code>, <code>vpvMyVectorOfPointersToVectors</code>.
* <code>fn</code> для функций: <code>pfnMyCallback</code>, <code>m_papfnMyPointerToArrayOfCallbacks</code>.


<span id="Common_snippets"></span>
== Общие фрагменты ==

Вот список кода, который вы можете часто встретить в кодовой базе:


<span id="Formatting_text"></span>
=== Форматирование текста ===

<syntaxhighlight lang="cpp">
char aBuf[128];
str_format(aBuf, sizeof(aBuf), "number: %d", 2);
</syntaxhighlight>

Список всех спецификаторов форматирования см. в [https://cplusplus.com/reference/cstdio/printf/ документации по printf].
=== Итерация по всем игрокам ===

<syntaxhighlight lang="cpp">
for(int i = 0; i < MAX_CLIENTS; i++)
{
    // Server-side
    CPlayer *pPlayer = GameServer()->m_apPlayers[i];
}
</syntaxhighlight>


<span id="Printing_to_the_game_console"></span>
=== Печать на игровой консоли ===

<syntaxhighlight lang="cpp">
Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "wikiprint", "Hello from the ddnet wiki!");
</syntaxhighlight>



<span id="Debug_printing"></span>
=== Отладочная печать ===

<syntaxhighlight lang="cpp">
int i = 2;
dbg_msg("wikiprint", "Hello from the ddnet wiki: %d", i);
</syntaxhighlight>

=== Перевод текста в клиенте ===
<code>Localize</code> можно использовать в клиенте игры, чтобы получить перевод для определенной строки из языкового файла, выбранного пользователем.
<syntaxhighlight lang="cpp">
DoButton(..., Localize("Connect"), ...);
</syntaxhighlight>Строка может также содержать спецификаторы формата. Переведенная строка должна содержать те же спецификаторы форматирования.<syntaxhighlight lang="cpp">
char aBuf[128];
str_format(aBuf, sizeof(aBuf), Localize("%d of %d servers"), NumServers, TotalServers);
</syntaxhighlight>Скрипт используется для сканирования кода на наличие вызовов <code>Localize</code> и сбора строк для обновления файлов перевода. По этой причине вызов <code>Localize</code> не должен содержать никакого другого кода, иначе скрипт не сможет правильно определить текст.
<syntaxhighlight lang="cpp">
// НЕ делайте этого:
const char *pStr = Localize(Team == TEAM_RED ? "Red team" : "Blue team");

// Вместо этого сделайте следующее:
const char *pStr = Team == TEAM_RED ? Localize("Red team") : Localize("Blue team");
</syntaxhighlight

<span id="External_resources"></span>
== Внешние ресурсы ==

* [https://edgarluque.com/blog/ui-code-ddnet/ Код пользовательского интерфейса в DDraceNetwork] от [[Special:MyLanguage/User:Ryozuki|Ryozuki]]
* [https://edgarluque.com/blog/intro-to-ddnet/ Знакомство с исходным кодом игры DDraceNetwork]  от [[Special:MyLanguage/User:Ryozuki|Ryozuki]]
* [https://edgarluque.com/blog/code-conventions-in-ddnet/ Соглашения о коде в DDraceNetwork]  от [[Special:MyLanguage/User:Ryozuki|Ryozuki]]
* [https://edgarluque.com/blog/chat-command-ddracenetwork/ Реализация команды чата в DDraceNetwork]  от [[Special:MyLanguage/User:Ryozuki|Ryozuki]]
* [https://codedoc.ddnet.org/ Автоматически сгенерированная документация]
* [https://ddnet.org/libtw2-doc/ Техническая документация по форматам файлов Teeworlds и сетевому протоколу]
* [https://heinrich5991.github.io/blog/blog/one-tick-unfreeze Анатомия размораживания одного тика]
* [https://www.youtube.com/playlist?list=PLhJkqAQmOh5LyYOfnMy4PJB6CSZltQyTc YouTube-учебник по программированию Teeworlds] от ChillerDragon

<span id="About_Tee_Skin_Rendering"></span>
== О рендеринге скинов ==

В этом разделе описано, как выполнить рендеринг скина тии.

 Значения собраны вместе Patiga
 Особая благодарность компании Jupstar
 
 Масштабирование сегментов:
    тело: 100%
    ноги: 150%
    глаза: 120%
    моргание глаз: 45%
    рука: 93,75%
 
 Позиционирование:
    64/64 = 1 = ширина или высота сегмента тела
    туловище: 4/64 вверх
    ноги:
        10/64 вниз
        7/64 влево/вправо
    глаза:
        0,125 вверх
        0,05 влево/вправо
 
    движение глаз:
        dir = угол наклона глаз (угол обзора), правый = 0
        глаза:
            x: cos(dir) * 0.125
            y: sin(dir) * 0.1
        каждый глаз (в сторону от другого):
            x: abs(cos(dir)) * 0.01