Development/ru: Difference between revisions

From DDraceNetwork
Created page with "В настоящее время применяется следующее:"
Created page with "==== Серверная сторона ===="
Line 177: Line 177:
=== Именование переменных ===
=== Именование переменных ===


<div lang="en" dir="ltr" class="mw-content-ltr">
* Имена переменных содержат 3 части: классификатор, префикс и имя.
* The names of variables contain 3 parts: qualifier, prefix and name.
* Имена переменных должны начинаться с прописной буквы, если только они не имеют длину в 1 символ без какого-либо префикса или определителя, например: <code>i</code>, <code>x</code>, <code>y</code>.
* Variable names should start with uppercase unless they are 1 char long without any prefix or qualifier, for example: <code>i</code>, <code>x</code>, <code>y</code>.
* Переменные могут иметь более 1 классификатора (или нуля) и более 1 префикса (или нуля).
* Variables can have more than 1 qualifier (or zero) and more than 1 prefix (or zero).
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Они расположены следующим образом: <code>[qualifiers]_[prefixes][Name]</code>
These are laid out like this: <code>[qualifiers]_[prefixes][Name]</code>
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Qualifiers"></span>
==== Qualifiers ====
==== Квалификаторы ====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* <code>m</code> для переменных-членов: <code>m_MyVariable</code>.
* <code>m</code> for member variables: <code>m_MyVariable</code>.
* <code>s</code> для статических переменных: <code>s_MyStaticVariable</code>, <code>ms_MyStaticMemberVariable</code>.
* <code>s</code> for static variables: <code>s_MyStaticVariable</code>, <code>ms_MyStaticMemberVariable</code>.
* <code>g</code> для глобальных переменных с внешней связью: <code>gs_MyGlobalStaticVar</code>.
* <code>g</code> for global variables with external linkage: <code>gs_MyGlobalStaticVar</code>.
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Prefixes"></span>
==== Prefixes ====
==== Префиксы ====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* <code>p</code> для указателей: <code>pMyPointer</code>, <code>m_pCharacter</code>, <code>ppMyPointerToPointer</code>.
* <code>p</code> for pointers: <code>pMyPointer</code>, <code>m_pCharacter</code>, <code>ppMyPointerToPointer</code>.
* <code>a</code> для массивов: <code>aMyArray</code>, <code>aBuf</code>.
* <code>a</code> for arrays: <code>aMyArray</code>, <code>aBuf</code>.
* <code>v</code> для <code>std::vector</code>s: <code>vMyVector</code>, <code>vpvMyVectorOfPointersToVectors</code>.
* <code>v</code> for <code>std::vector</code>s: <code>vMyVector</code>, <code>vpvMyVectorOfPointersToVectors</code>.
* <code>fn</code> для функций: <code>pfnMyCallback</code>, <code>m_papfnMyPointerToArrayOfCallbacks</code>.
* <code>fn</code> for functions: <code>pfnMyCallback</code>, <code>m_papfnMyPointerToArrayOfCallbacks</code>.
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Common_snippets"></span>
== Common snippets ==
== Общие фрагменты ==
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Вот список кода, который вы можете часто встретить в кодовой базе:
Here is a list of code that you may frequently see across the codebase:
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Formatting_text"></span>
=== Formatting text ===
=== Форматирование текста ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="cpp">
<syntaxhighlight lang="cpp">
char aBuf[128];
char aBuf[128];
str_format(aBuf, sizeof(aBuf), "number: %d", 2);
str_format(aBuf, sizeof(aBuf), "number: %d", 2);
</syntaxhighlight>
</syntaxhighlight>
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Iterating_over_all_players"></span>
=== Iterating over all players ===
=== Итерация по всем игрокам ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="cpp">
<syntaxhighlight lang="cpp">
for(int i = 0; i < MAX_CLIENTS; i++)
for(int i = 0; i < MAX_CLIENTS; i++)
Line 244: Line 226:
}
}
</syntaxhighlight>
</syntaxhighlight>
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Printing_to_the_game_console"></span>
=== Printing to the game console ===
=== Печать на игровой консоли ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="cpp">
<syntaxhighlight lang="cpp">
Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "wikiprint", "Hello from the ddnet wiki!");
Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "wikiprint", "Hello from the ddnet wiki!");
</syntaxhighlight>
</syntaxhighlight>
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Debug_printing"></span>
=== Debug printing ===
=== Отладочная печать ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="cpp">
<syntaxhighlight lang="cpp">
int i = 2;
int i = 2;
dbg_msg("wikiprint", "Hello from the ddnet wiki: %d", i);
dbg_msg("wikiprint", "Hello from the ddnet wiki: %d", i);
</syntaxhighlight>
</syntaxhighlight>
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="External_resources"></span>
== External resources ==
== Внешние ресурсы ==
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<div lang="en" dir="ltr" class="mw-content-ltr">

Revision as of 23:00, 7 June 2023

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


Ваша среда разработки

Крайне рекомендуется установить среду Linux для начала программирования в DDNet по следующим причинам (на данный момент):

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

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

Некоторые полезные ресурсы для изучения C++:

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

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


Получение исходного кода

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

Если вы не знакомы с git/github, вы можете изучить основы здесь: Hello World - Github.


Установка зависимостей

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

Для Arch Linux:

sudo pacman -S --needed base-devel cmake curl freetype2 git glew gmock libnotify opusfile python sdl2 sqlite wavpack


Компиляция DDNet

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

mkdir build
cd build
cmake ..
make -j$(nproc)


Общая информация

Вот некоторые общие сведения:

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


Расположение исходного кода

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


Каталог src/base

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


Каталог src/engine

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


Каталог src/game

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


Серверная сторона

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

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

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

  • CCharacter: Представляет собой тии, который является живым, он создается при порождении тии и удаляется при его смерти. Информацию о том, как игрок сохраняется между смертями, см. в CPlayer.


Клиентская сторона

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


Сетевое взаимодействие

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


Кодовые конвенции

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

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


Indentation стиль

Allman style используется.

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

while(x == y)
{
    Something();
    SomethingElse();
}

Finalthing();


Классы и структуры

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

Пример:

class CCharacter : public CEntity
{
    // ...
}


Перечисления и константы

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

enum
{
	FAKETUNE_FREEZE = 1,
	FAKETUNE_SOLO = 2,
	FAKETUNE_NOJUMP = 4,
	FAKETUNE_NOCOLL = 8,
	FAKETUNE_NOHOOK = 16,
	FAKETUNE_JETPACK = 32,
	FAKETUNE_NOHAMMER = 64,
};


Именование переменных

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

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


Квалификаторы

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


Префиксы

  • p для указателей: pMyPointer, m_pCharacter, ppMyPointerToPointer.
  • a для массивов: aMyArray, aBuf.
  • v для std::vectors: vMyVector, vpvMyVectorOfPointersToVectors.
  • fn для функций: pfnMyCallback, m_papfnMyPointerToArrayOfCallbacks.


Общие фрагменты

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


Форматирование текста

char aBuf[128];
str_format(aBuf, sizeof(aBuf), "number: %d", 2);


Итерация по всем игрокам

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


Печать на игровой консоли

Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "wikiprint", "Hello from the ddnet wiki!");


Отладочная печать

int i = 2;
dbg_msg("wikiprint", "Hello from the ddnet wiki: %d", i);


Внешние ресурсы