SS220 Paradise Wiki (SS13) - Вклад [ru]

Запуск локального сервера

2024-12-14T07:53:01Z

Vladisvell: Дополнение к правкам и актуализации гайда по запуску локального сервера

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

==Видеогайд по запуску локального сервера==
‎<youtube width="540" height="280">Lx-b77NBM8Q</youtube>
==Локальный сервер==
Локальный сервер, или же на сленге "Локалка" - это сервер Space Station, запущенный на вашей локальной машине. Причин для его запуска может быть множество - от изучения функционала игры, тренировки навыка охоты на мегафауну, подрыва лимиток ... вплоть до вызова лорда Сингуло. Последовательность запуска ниже, представлена для билда '''[https://github.com/ss220-space/Paradise Paradise SS1984]'''

==Приготовления\компиляция==
# [https://github.com/ss220-space/Paradise/archive/refs/heads/master220.zip '''Скачайте билд Paradise SS1984'''] (скачивание начнется сразу после нажатия на ссылку)
# После завершения скачивания, разархивируйте в любое удобное вам место.
# Зайдите в разархивированную вами папку. Найдите папку <code>config</code> и зайдите в неё. Там будет папка с названием <code>example</code>, зайдите в неё. Скопируйте все файлы оттуда назад, в папку <code>config</code>. Если этого '''не сделать''' ваш персонаж будет <u>слишком</u> быстро перемещаться, и по ходу игры могут возникнуть некоторые иные проблемы.
# Найдите, в основной папке, файл <code>paradise.dme</code>, откройте его. Через некоторое время откроется Dream Maker.
# Для задания карты помимо Кибериады: зайдите в папку <code>config</code>. В ней найдите <code>config.txt</code>. Нажмите <code>CTRL + F</code> и введите <code>Default server map</code>. Укажите необходимую карту по умолчанию написав после <code>DEFAULT_MAP /datum/map/</code> одно из значений: <code>cyberiad</code> (Кибериада), <code>delta</code> (Керберос), <code>cerestation</code> (Фаррагус), <code>celestation</code>(Селестион, Multi-Z), <code>nova</code>(Нова, Multi-Z). Сохраните документ нажав <code>CTRL + S</code>.<br>Смена карты на уже запущенном сервере происходит через права администратора во вкладке <code>Server</code> кнопка <code>Select next map</code>.
#Теперь нажмите в верхнем меню <code>Build</code> → <code>Compile</code>.
#Подождите окончания компиляции, это займет несколько минут.
#Если всё вышеперечисленное сделано вами было верно, то в конце журнала вы увидите: <pre>paradise.dmb - 0 errors, 0 warnings</pre>В этом случае можно приступать к дальнейшему запуску.

==Сохранение в базе данных ==
В случае, если вы хотите избежать сбрасывания настроек при каждом запуске, смотрите '''[https://wiki.ss220.space/index.php/Настройка_базы_данных руководство по настройке тут].'''

==Запуск==
[[Файл:Dream Daemon.png|обрамить|Dream Daemon]]Одиночная игра, сервер отключается после выхода

# В верхнем меню, там где нажимали кнопку компиляции, нажмите Run, или Ctrl+R. Вы сразу попадете в игру.

Выделенный сервер, не отключается после выхода игроков.
#Найдите <code>Dream Daemon</code>, через меню «Пуск» (если вы уже установили BYOND, то Dream Daemon также у вас установлен вместе с ним) и запустите его.
#Нажмите на <code>File</code> → <code>Open</code>. Вам откроется проводник — найдите папку (Paradise-master220) в которую вы разархивировали билд, найдите в ней файл <code>paradise.dmb</code>, выберите его, подтвердите выбор.
#Подождите пару секунд, пока Dream Daemon его загрузит.
#Переключите Security в режим Trusted, иначе игра будет спрашивать вас о разрешении об открытии каждого файла.
#В правом нижнем углу появится зеленая кнопка GO[[File:GO.png]]. Нажмите на неё.
#Ожидайте запуска сервера демоном (примерно 5–20 секунд).
#Над кнопкой GO [[File:GO.png]] появится жёлтая кнопка со стрелочкой [[File:Join.png]] — нажмите её, чтобы зайти на сервер.
#Всё. Вы получили ваш собственный сервер!
#Чтобы выключить сервер — нажмите на красную кнопку STOP [[File:STOP.png]]

==Администрирование==
Заходя на ваш сервер, вы получаете максимальные права, дающие вам все возможности администратора. Более подробно об огромном количестве возможностей (спавн предметов и тд.), что вы получите в своё распоряжение, вы можете почитать в '''[[Щитспавн для чайников/Admin|данном руководстве]]'''.

==Запуск двух локалок на одном компьютере==
Редко, но может понадобится, возможность зайти на одном компьютере на две локалки сразу. Например для тестирования способностей вампира, т.к. чтобы накапливать очки для способностей вампира, нужно высасывать кровь из жертвы за которую играет человек.

#Закройте (убейте процесс) <code>BYOND</code>.
#Первую локалку мы запускаем через <code>Dream Daemon</code> , нажав желтую кнопку [[File:Join.png]] <code>Join</code>.
#После того, как первая успешно загружена, сворачиваем её. Включаем BYOND, ждем загрузки.
#Снова открываем <code>Dream Daemon</code> , подключаемся через желтую кнопку [[File:Join.png]] <code>Join</code>. Готово у вас 2 локалки.

'''Альтернативно''' можно:

#Открыть <code>BYOND</code>
#Зайти в ваш аккаунт (если вы ещё не зашли), и после зайти на сам сервер через [[File:Join.png]] <code>Join</code> в <code>Dream Daemon</code> (как обычно, т.е.).
#Снова открыть <code>BYOND</code>. Далее выйти из вашего аккаунта (Logout около вашего ника)
#Снова нажать на [[File:Join.png]] <code>Join</code>.

[[Файл:Localka x2.png|без|мини|308x308пкс|Как выглядят две локалки на одном компьютере]]

==Прочее==

===Продвинутый запуск===
Либо вам все равно нечего делать, либо вам интересно создать чуть-менее локальную локалку.
Самое первое — разберем что это за кнопки на моменте запуска

;<code>Port</code>
:Номер порта, который Dream Daemon будет использовать для этого сервера. Если вам не нужны игроки — можете забыть об этом.
:;<code>0</code>
::Dream Daemon случайно выберет порт.
;<code>Security</code>
:Отвечает за собственно, безопасность. Имеет три режима
:;<code>Trusted</code>
::Никакой защиты. Рекомендуется лишь на локалках, где вы единственный игрок/все остальные ваши друзья.
:;<code>Safe</code>
::Стандартная защита. Лучший вариант. Рекомендуется.
:; <code>Ultrasafe</code>
::Максимальная защита! Постоянные запросы ''«Вы разрешаете получить доступ к НАЗВАНИЕ_ФАЙЛА?»''. Настоятельно не рекомендуется.
; <code>Visibility</code>
:Отвечает за отображение сервера в хабе и иных местах. Имеет три режима:
:;<code>Public</code>
::Локалка видна в хабе Space Station (без [[#Отображение_в_хабе|ОСОБЫХ УХИЩРЕНИЙ]] не сработает!)
:;<code>Private</code>
::Приватный режим. Ваши друзья в Byond смогут увидеть этот сервер, но все остальные — нет.
:;<code>Invisible</code>
::Режим скрытности. Рекомендуется для одиночных тестирований. Никто не видит ваш сервер, но подключение через ссылку по прежнему работает.

=== Отображение в хабе===

Изначально ваш сервер не будет виден в хабе, даже если ваши порты открыты и режим <code>Public</code>. Это связано с тем, что изначально ваш сервер «Закрыт». Впрочем, это достаточно легко исправить, если вам это нужно.

Вот инструкция

#Зайдите в папку с билдом. Найдите папку <code>Config</code>, откройте её.
# Найдите в этой папке текстовый файл <code>config.txt</code>. Откройте его используя что-то для просмотра кода (например Visual Studio Code, сам Dream Maker или что-то в этом духе).
#Используя поиск (<kbd>Ctrl +</kbd> А или же <kbd>Ctrl + F</kbd>) найдите <code>MEDAL_HUB_ADDRESS</code>. Удалите около него (ЛИШЬ ОКОЛО НЕГО) <code>#</code>, и запишите собственно название. Выше него будет описано, как его сделать, но если просто — придумайте что-то в духе <code>Hubmakerckey.Hubname</code>, т. е. например <code>Honkhonkhonk.SS13</code>.
#Используя поиск, найдите <code>MEDAL_HUB_PASSWORD</code>. Несмотря на название, это не совсем пароль. Это условное обозначение сервера, его настроить можно так: <code>3qb77RnAX0</code>. Можете использовать его так, или использовать собственный <code>MEDAL_HUB_PASSWORD</code>. Также уберите <code>#</code> около него.

P.S. Возможно это НЕ сработает. Во первых — это актуально лишь для Paradise, на других серверах по иному, а во-вторых это может быть просто не правильно. Правильность все ещё уточняется, да.
==Запуск по кодерски==
Существует способ который позволит вам сразу скомпилировать билд и запустить вашу локалку для одного компьютера. Это полезно, если вам не нужен вторая локалка на одном компьютере для тестов, вы тестируете новые значения внесенные в код, вам нужно быстро зайти и проверить то что вы сделали, без нажатия на лишние кнопки и муторного запуска Dream Daemon. <br>
Для этого вам понадобится [[paradise:Руководство_по_разработке#Устанавливаем_и_настраиваем_Visual_Studio_Code|Visual Studio Code (VSC)]]

После прохождения гайда по установке VSC, обязательно проверьте:
#Не выдает ли VSC никаких ошибок при открытии билда
#Скачали ли вы все предложенные плагины для работы с DM (для быстрой работы с кодом)
#Перенесли ли вы все файлы конфигов из папки <code>/config/example</code> в папку <code>/config</code> (для нормализации скорости и кнопочек)
#Вписали ли вы свой сикей в конфиг админов (иначе вы не сможете пользоваться кнопочками)
#Отсутствие запущенного Dream Daemon (иначе могут появляться ошибки с иконками)
#Запущенный BYOND (чтобы игра видела ваш сикей и дала кнопочки)

Как только все пункты пройдены и вы уверены что всё отлично, вы можете запустить вашу персональную локалку нажатием всего одной клавиши: '''F5'''

Либо же лично запустить отладку:

[[File:Otladka.png]]

==У меня на локалке 2 карты или поломан свет==
#В Dream maker уберите отметки со всех файлов с форматом .dmm
[[Файл:No ticks on dmm files.png|мини|Пример. Отмеченных галками не должно быть для файлов с форматом .dmm]]

{{Contribution Guides}}

Запуск локального сервера

2024-12-14T07:47:29Z

Vladisvell:

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

==Видеогайд по запуску локального сервера==
‎<youtube width="540" height="280">Lx-b77NBM8Q</youtube>
==Локальный сервер==
Локальный сервер, или же на сленге "Локалка" - это сервер Space Station, запущенный на вашей локальной машине. Причин для его запуска может быть множество - от изучения функционала игры, тренировки навыка охоты на мегафауну, подрыва лимиток ... вплоть до вызова лорда Сингуло. Последовательность запуска ниже, представлена для билда '''[https://github.com/ss220-space/Paradise Paradise SS1984]'''

==Приготовления\компиляция==
# [https://github.com/ss220-space/Paradise/archive/refs/heads/master220.zip '''Скачайте билд Paradise SS220'''] (скачивание начнется сразу после нажатия на ссылку)
# После завершения скачивания, разархивируйте в любое удобное вам место.
# Зайдите в разархивированную вами папку. Найдите папку <code>config</code> и зайдите в неё. Там будет папка с названием <code>example</code>, зайдите в неё. Скопируйте все 18 файлов из этой папки назад, в папку <code>config</code>. Если этого '''не сделать''' ваш персонаж будет <u>слишком</u> быстро перемещаться, и по ходу игры могут возникнуть некоторые иные проблемы.
# Найдите, в основной папке, файл <code>paradise.dme</code>, откройте его. Через некоторое время откроется Dream Maker.
# Для задания карты помимо Кибериады: зайдите в папку <code>config</code>. В ней найдите <code>config.txt</code>. Нажмите <code>CTRL + F</code> и введите <code>Default server map</code>. Укажите необходимую карту по умолчанию написав после <code>DEFAULT_MAP /datum/map/</code> одно из значений: <code>cyberiad</code> (Кибериада), <code>delta</code> (Керберос), <code>cerestation</code> (Фаррагус), <code>celestation</code>(Селестион, Multi-Z), <code>nova</code>(Нова, Multi-Z). Сохраните документ нажав <code>CTRL + S</code>.<br>Смена карты на уже запущенном сервере происходит через права администратора во вкладке <code>Server</code> кнопка <code>Select next map</code>.
#Теперь нажмите в верхнем меню <code>Build</code> → <code>Compile</code>.
#Подождите окончания компиляции, это займет несколько минут.
#Если всё вышеперечисленное сделано вами было верно, то в конце журнала вы увидите: <pre>paradise.dmb - 0 errors, 0 warnings</pre>В этом случае можно приступать к дальнейшему запуску.

==Сохранение в базе данных ==
В случае, если вы хотите избежать сбрасывания настроек при каждом запуске, смотрите '''[https://wiki.ss220.space/index.php/Настройка_базы_данных руководство по настройке тут].'''

==Запуск==
[[Файл:Dream Daemon.png|обрамить|Dream Daemon]]Одиночная игра, сервер отключается после выхода

# В верхнем меню, там где нажимали кнопку компиляции, нажмите Run, или Ctrl+R. Вы сразу попадете в игру.

Выделенный сервер, не отключается после выхода игроков.
#Найдите <code>Dream Daemon</code>, через меню «Пуск» (если вы уже установили BYOND, то Dream Daemon также у вас установлен вместе с ним) и запустите его.
#Нажмите на <code>File</code> → <code>Open</code>. Вам откроется проводник — найдите папку (Paradise-master220) в которую вы разархивировали билд, найдите в ней файл <code>paradise.dmb</code>, выберите его, подтвердите выбор.
#Подождите пару секунд, пока Dream Daemon его загрузит.
#Переключите Security в режим Trusted, иначе игра будет спрашивать вас о разрешении об открытии каждого файла.
#В правом нижнем углу появится зеленая кнопка GO[[File:GO.png]]. Нажмите на неё.
#Ожидайте запуска сервера демоном (примерно 5–20 секунд).
#Над кнопкой GO [[File:GO.png]] появится жёлтая кнопка со стрелочкой [[File:Join.png]] — нажмите её, чтобы зайти на сервер.
#Всё. Вы получили ваш собственный сервер!
#Чтобы выключить сервер — нажмите на красную кнопку STOP [[File:STOP.png]]

==Администрирование==
Заходя на ваш сервер, вы получаете максимальные права, дающие вам все возможности администратора. Более подробно об огромном количестве возможностей (спавн предметов и тд.), что вы получите в своё распоряжение, вы можете почитать в '''[[Щитспавн для чайников/Admin|данном руководстве]]'''.

==Запуск двух локалок на одном компьютере==
Редко, но может понадобится, возможность зайти на одном компьютере на две локалки сразу. Например для тестирования способностей вампира, т.к. чтобы накапливать очки для способностей вампира, нужно высасывать кровь из жертвы за которую играет человек.

#Закройте (убейте процесс) <code>BYOND</code>.
#Первую локалку мы запускаем через <code>Dream Daemon</code> , нажав желтую кнопку [[File:Join.png]] <code>Join</code>.
#После того, как первая успешно загружена, сворачиваем её. Включаем BYOND, ждем загрузки.
#Снова открываем <code>Dream Daemon</code> , подключаемся через желтую кнопку [[File:Join.png]] <code>Join</code>. Готово у вас 2 локалки.

'''Альтернативно''' можно:

#Открыть <code>BYOND</code>
#Зайти в ваш аккаунт (если вы ещё не зашли), и после зайти на сам сервер через [[File:Join.png]] <code>Join</code> в <code>Dream Daemon</code> (как обычно, т.е.).
#Снова открыть <code>BYOND</code>. Далее выйти из вашего аккаунта (Logout около вашего ника)
#Снова нажать на [[File:Join.png]] <code>Join</code>.

[[Файл:Localka x2.png|без|мини|308x308пкс|Как выглядят две локалки на одном компьютере]]

==Прочее==

===Продвинутый запуск===
Либо вам все равно нечего делать, либо вам интересно создать чуть-менее локальную локалку.
Самое первое — разберем что это за кнопки на моменте запуска

;<code>Port</code>
:Номер порта, который Dream Daemon будет использовать для этого сервера. Если вам не нужны игроки — можете забыть об этом.
:;<code>0</code>
::Dream Daemon случайно выберет порт.
;<code>Security</code>
:Отвечает за собственно, безопасность. Имеет три режима
:;<code>Trusted</code>
::Никакой защиты. Рекомендуется лишь на локалках, где вы единственный игрок/все остальные ваши друзья.
:;<code>Safe</code>
::Стандартная защита. Лучший вариант. Рекомендуется.
:; <code>Ultrasafe</code>
::Максимальная защита! Постоянные запросы ''«Вы разрешаете получить доступ к НАЗВАНИЕ_ФАЙЛА?»''. Настоятельно не рекомендуется.
; <code>Visibility</code>
:Отвечает за отображение сервера в хабе и иных местах. Имеет три режима:
:;<code>Public</code>
::Локалка видна в хабе Space Station (без [[#Отображение_в_хабе|ОСОБЫХ УХИЩРЕНИЙ]] не сработает!)
:;<code>Private</code>
::Приватный режим. Ваши друзья в Byond смогут увидеть этот сервер, но все остальные — нет.
:;<code>Invisible</code>
::Режим скрытности. Рекомендуется для одиночных тестирований. Никто не видит ваш сервер, но подключение через ссылку по прежнему работает.

=== Отображение в хабе===

Изначально ваш сервер не будет виден в хабе, даже если ваши порты открыты и режим <code>Public</code>. Это связано с тем, что изначально ваш сервер «Закрыт». Впрочем, это достаточно легко исправить, если вам это нужно.

Вот инструкция

#Зайдите в папку с билдом. Найдите папку <code>Config</code>, откройте её.
# Найдите в этой папке текстовый файл <code>config.txt</code>. Откройте его используя что-то для просмотра кода (например Visual Studio Code, сам Dream Maker или что-то в этом духе).
#Используя поиск (<kbd>Ctrl +</kbd> А или же <kbd>Ctrl + F</kbd>) найдите <code>MEDAL_HUB_ADDRESS</code>. Удалите около него (ЛИШЬ ОКОЛО НЕГО) <code>#</code>, и запишите собственно название. Выше него будет описано, как его сделать, но если просто — придумайте что-то в духе <code>Hubmakerckey.Hubname</code>, т. е. например <code>Honkhonkhonk.SS13</code>.
#Используя поиск, найдите <code>MEDAL_HUB_PASSWORD</code>. Несмотря на название, это не совсем пароль. Это условное обозначение сервера, его настроить можно так: <code>3qb77RnAX0</code>. Можете использовать его так, или использовать собственный <code>MEDAL_HUB_PASSWORD</code>. Также уберите <code>#</code> около него.

P.S. Возможно это НЕ сработает. Во первых — это актуально лишь для Paradise, на других серверах по иному, а во-вторых это может быть просто не правильно. Правильность все ещё уточняется, да.
==Запуск по кодерски==
Существует способ который позволит вам сразу скомпилировать билд и запустить вашу локалку для одного компьютера. Это полезно, если вам не нужен вторая локалка на одном компьютере для тестов, вы тестируете новые значения внесенные в код, вам нужно быстро зайти и проверить то что вы сделали, без нажатия на лишние кнопки и муторного запуска Dream Daemon. <br>
Для этого вам понадобится [[paradise:Руководство_по_разработке#Устанавливаем_и_настраиваем_Visual_Studio_Code|Visual Studio Code (VSC)]]

После прохождения гайда по установке VSC, обязательно проверьте:
#Не выдает ли VSC никаких ошибок при открытии билда
#Скачали ли вы все предложенные плагины для работы с DM (для быстрой работы с кодом)
#Перенесли ли вы все файлы конфигов из папки <code>/config/example</code> в папку <code>/config</code> (для нормализации скорости и кнопочек)
#Вписали ли вы свой сикей в конфиг админов (иначе вы не сможете пользоваться кнопочками)
#Отсутствие запущенного Dream Daemon (иначе могут появляться ошибки с иконками)
#Запущенный BYOND (чтобы игра видела ваш сикей и дала кнопочки)

Как только все пункты пройдены и вы уверены что всё отлично, вы можете запустить вашу персональную локалку нажатием всего одной клавиши: '''F5'''

Либо же лично запустить отладку:

[[File:Otladka.png]]

==У меня на локалке 2 карты или поломан свет==
#В Dream maker уберите отметки со всех файлов с форматом .dmm
[[Файл:No ticks on dmm files.png|мини|Пример. Отмеченных галками не должно быть для файлов с форматом .dmm]]

{{Contribution Guides}}

Файл:No ticks on dmm files.png

2024-12-14T07:44:17Z

Vladisvell:

Отсутствие отметок на dmm файлах в Dream Maker

Руководство по разработке

2024-03-23T09:21:04Z

Vladisvell: Обновление инструкции по установке ПО для работы с TGUI

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code для удобного редактирования и отладки кода.]]
* [[#Установка и настройка Github|Настройка GitHub для начала работы с билдом.]]

=== Взаимодействие с Git ===
* [[#Настройка и использование Github Desktop|Установка и использование Github Desktop (Дружелюбно к новичкам)]]
* [[#Установка и использование TortoiseGit|(Альтернативно) Установка и использование TortoiseGit (Поддерживает работу с Git через контекстное меню Windows)]]
* [[#Форк кода Парадайза|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Запуск локальной версии билда ===
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon? (Не рекомендуется для отладки, но есть возможность запуска сервера на несколько игроков)]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через Visual Studio Code? (Рекомендуется для отладки, не поддерживает мультиплеер)]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Маппинг (Редактирование карт) ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]

=== Спрайтинг ===
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== TGUI (Красивые интерфейсы внутри игры) ===
* [[#Руководство по началу работы с TGUI|Как начать работу с TGUI]]
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]

=== Дополнительно ===
* [[Как делать перевод игры]]?

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Форк кода Парадайза|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>bugfix: Исправлена ошибка с X, когда вы Y
tweak: усилен X, чтобы наносить Y больше урона. </pre>
Старайтесь вкратце, желательно на английском, делать заголовок Pull Request'а.
Название заголовка есть "тег: краткое описание", например: '''bugfix: now table climbs do not cause server crash'''.
В данный момент журнал изменений отображается внтури игры. Там Вы, и любой другой игрок, можете ознакомиться с обновлениями.

Какие теги ставить перед Вашим PR:
* bugfix: если Вы исправили некий баг
* add: если Вы добавили новую фичу
* imageadd: если просто поменяли спрайты, без затрагивания кода
* soundadd: если просто добавили новые звуки, без затрагивания кода
* tweak: если Вы сделали незначительную правку (например изменили одно число на другое)
* balance: то же что и tweak, но когда изменений множество
* refactor: если Вы полностью переписали старый код, улучшив его, НО не изменив функционал
* qol: если Ваше изменение не влияет на баланс, а только улучшает взаимодействие между игрой и игроком
* wip: если Ваш PR в драфте и планируется длительная разработка (можно не ставить)

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

===Как сделать хорошую демонстрацию изменений===
ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Форк кода Парадайза|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Форк кода Парадайза|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Нажмите ПКМ по рабочей папке. Выберите '''TortoiseGit''', затем '''Push...'''
* Задайте '''Local''' и '''Remote''' имя ветки, в которую вы совершили коммиты ранее (например My_First_Branch)
* Под Destination, задайте Remote: to '''origin'''.
* Нажмите '''Ok'''. Это отправит изменения на удаленный репозиторий (На гитхабе).
* Зайдите в свой репозиторий (пример https://github.com/NAME/Paradise)
* Нажмите '''Pull Request''' справа сверху.
* Создайте Pull Request, следуя инструкциям из пресозданного шаблона.
* Получилось! Во многих случаях будут обнаружены ошибки, которые будут выделены другими участниками сообщества, merge-conflict'ы и другие вещи, что заставит Вас посещать Pull Request вновь.
* Опционально, загляните в раздел Clean Commits для руководства по чистым коммитам, '''которые помогают мейнтейнерам легче проводить ревью!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS последней версии https://nodejs.org/en/download/'''
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.

Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по еде и напиткам/Рецепты Бутылочницы

2023-11-27T14:04:45Z

Vladisvell: Баг с невозможностью сделать отравленный вариант был исправлен

{| class="wikitable" width="100%" valign="top"
!Название
!Рецепт
!Описание
|-
!'''Яблопокалипсис''' (Apple-pocalypse)
|Apple, Apple, Apple
|Если бы Судный день проходил в виде фруктов, то это, вероятно, были бы яблоки. С шансом в 1% мощная отрыжка растолкает вещи в радиусе 2 тайлов.
|-
!'''Забаненный плод''' (Berry Banned)
|Berries, Berries, Berries
|Ощути пермабан. Незначительно исцеляет физический/ожоговый/токсиновый урон и урон мозгу.
|-
!'''Забаненный плод''' (Berry Banned)
|Poison Berries, Poison Berries, Poison Berries
|Альтернативный рецепт. В отличии от своего аналога, не лечит, а наносит урон токсинами.
|-
!'''Черноглазое варево''' (Blackeye Brew)
|Cola, Sugar Cane, Ice Cream
|Сливочный, мягкий вкус, совсем как у лысых голов. Предположительно в возрасте 30 лет. 25% шанс выкрикнуть «Грейтайдовую» фразу.
|-
!'''Виноградный взрыв''' (Grape Granade)
|Grape Juice, Grapes, Flash
|Взрывается с виноградным ароматом и является фаворитом среди членов [[Отряд быстрого реагирования|ОБР]] по всей системе. Имеет шанс в 1% притянуть все вещи в радиусе 3 тайлов.
|-
!'''Метеорный солод''' (Meteor Malt)
|Unrefined Ore, Wheat, Unrefined Ore
|Безалкогольные напитки были обнаружены на пути столкновения с вашими вкусовыми рецепторами. С шансом в 25% трясёт экран и с шансом в 5% вводит в организм небольшую дозу случайной руды.
|-
!'''Райский удар''' (Paradise Punch)
|Grapes, Banana, Cherries
|Вкус именно такой, как вы думаете. Райский. Если вы сможете разлить этот напиток по бутылкам.
|-
!'''Мунлин двойной перегонки''' (Moon'drin)
|Moonlight, Moonlight, Moonlight
|Алкогольный мятный вкус, который так полюбился многим таярам. Используется в коктейлях.
|-
|}

Импланты

2023-11-02T13:59:29Z

Vladisvell: Корректировка описания улучшенного кибернетического сердца в соответствии с кодом импланта. Файл https://github.com/ss220-space/Paradise/blob/master220/code/modules/surgery/organs/heart.dm Код - /obj/item/organ/internal/heart/cybernetic/upgraded/on_life()

==Видеогайд по имплантам==

<youtube width="450" height="250">LhSv14PLP2g</youtube>

==Импланты NanoTrasen==

Высокотехнологические импланты, использование которых одобрило руководство [[NanoTrasen]].

{| class="items-table implants colors-Command"
|-
! style="width:15%;" | Предмет
! style="width:15%;" | Место установки
! Описание
|-
| {{Якорь|Имплант «Щит разума»|Mindshield Implant}} Имплант «Щит разума»

[[Файл:Implant.png]]

[[#Mindshield Implant|Mindshield Implant]]
| Грудь
| Те, кто имеет установленный имплант «Щит разума», защищены от «промывки мозгов». [[культист|Культ Нар’Си]], [[революция|революционеры]], или [[вампир]]ы уже не смогут завербовать и использовать вас в своё благо.

Данные должности на станции, по официальному прибытию с ЦК (не после назначения через [[ГП|Главу персонала]]) получают уже установленный имплант «Щит разума»

*[[Капитан]]
*[[Глава службы безопасности]]
*[[Смотритель]]
*[[Детектив]]
*[[Офицер службы безопасности]]
*[[Пилот челнока службы безопасности]]
*[[Врач брига]]
*[[Офицер «Синий щит»]]
*[[Магистрат]]
*[[Агент внутренних дел]]
*[[Представитель NanoTrasen]]

'''Обратите внимание:''' установленный имплант только позволяет в дальнейшем предотвратить «промывание мозгов», но не отменяет существующее (исключение — [[Революция|революционеры]], которых он деконвертирует).

Этот имплант имплантируются с помощью кейса с имплантами (<code>Implant Case</code>) и имплантера (<code>Implanter</code>).

Как и все импланты, он может быть [[Хирургия#Удаление_имплантов_(НЕ_ДЛЯ_СИНТЕТИКОВ)|удалён хирургическим вмешательством]], также снимая защиту от «промывки мозгов», но не возвращая её, если она была удалена им.
|-
| {{Якорь|Химический имплант|Chemical Implant}} Химический имплант

[[Файл:Implant.png]]

[[#Chemical Implant|Chemical Implant]]
| Грудь
| Используется для контроля над носителем. Установленный химический имплант может ввести носителю дозу любого заранее выбранного химического вещества. Используется также консоль управления заключенными (Prisoner Management Console).

Изначально химический имплант пуст, перед установкой необходимо попросить [[химик]]ов или [[учёный|учёных]] заполнить его.

У импланта нет ограничений на тип вводимого химического вещества. Это может быть как [[Руководство_по_фармакологии#Эфир|эфир]] или низкие дозы [[Руководство_по_фармакологии#Морфин|морфина]] для временного оглушения, и парализации. Так и смертельные токсины, такие как [[Руководство_по_фармакологии#зарин|Зарин]], [[Руководство_по_фармакологии#Нейротоксин|нейротоксин]] или [[Руководство_по_фармакологии#цианид|цианид]]. Если вы задаётесь вопросом, какое нужно выбрать химическое вещество, то отталкивайтесь от серьёзности преступления. И всё же желательно использовать несмертельные химические вещества.

Имплантируются с помощью кейса с имплантами (Implant Case) и имплантера (Implanter).

Имейте ввиду, что некоторые антагонисты, использующие регенерацию химических веществ внутри своего тела (такие как — [[Вампир]]ы или [[Генокрад]]ы) смогут легко очистить или препятствовать вводимым химическим веществам.

Как и все импланты, он может быть [[Хирургия#Удаление_имплантов_(НЕ_ДЛЯ_СИНТЕТИКОВ)|удалён хирургическим вмешательством]].
|-
| {{Якорь|Имплант слежения|Tracking Implant}} Имплант слежения

[[Файл:Implant.png]]

[[#Tracking Implant|Tracking Implant]]
| Грудь
| Используется для отслеживания положения члена экипажа. В основном для [[Стандартные_рабочие_процедуры_(Закон)#Условно-досрочное_освобождение|заключённых с УДО]].

Чтобы проверить, где находится носитель, используйте консоль управления заключёнными (Prisoner Management Console). Одна из таких консолей находится в кабинете [[смотритель|смотрителя]], другая — рядом с шаттлом для отправки на каторгу. Если имплант активен, консоль покажет вам его местоположение. Если использовать портативное устройство отслеживания (также доступно в наборе Tracking Implant), оно выдаст вам координаты импланта.

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

Этот имплант имплантируются с помощью кейса с имплантами (Implant Case) и имплантера (Implanter).

Как и все импланты, он может быть [[Хирургия#Удаление_имплантов_(НЕ_ДЛЯ_СИНТЕТИКОВ)|удалён хирургическим вмешательством]], также удаляя запись с консоли управления заключёнными.
|-
| {{Якорь|Имплант оповещения о смерти|Death Alarm Implant}} Имплант оповещения о смерти

[[Файл:Implant.png]]

[[#Death Alarm Implant|Death Alarm Implant]]
| Грудь
| Устанавливаются командному составу [[офицер «Синий щит»|офицером «Синий щит»]].

Имплант оповещения о смерти передают информацию о местонахождении носителя, когда его жизненные показатели перестают регистрироваться. Это позволяет быстро отреагировать персоналу, которому поручено спасение носителя, в том числе и самому [[офицер «Синий щит»|Щиту]].

Имплант оповещения о смерти не разряжается, но при воздействии ЭМИ он выходит из строя и передаёт случайное местоположение, даже если носитель ещё жив.
|-
| {{Якорь|Имплант изгоя|Exile implant}} Имплант изгоя

[[Файл:Implant.png]]

[[#Exile implant|Exile implant]]
| Грудь
| Меняет бортовую систему [[Врата|врат]], запрещая возвращение через [[Врата]] лицам с этим имплантом.

Обычно используется для [[Стандартные_рабочие_процедуры_(Закон)#Альтернатива:_Изгнание|изгнания преступников]].
|}

==Нелегальные импланты==

Данные импланты являются разработкой враждебных к [[NanoTrasen]] корпораций или признаны нелегальными Верховным судом NanoTrasen или уполномоченными лицами отдельного объекта NanoTrasen.

'''Их нельзя обнаружить медицинскими сканерами!'''

{| class="items-table implants colors-Antagonist"
|-
! style="width:15%;" | Предмет
! style="width:15%;" | Место установки
! Описание
|-
| {{Якорь|Адреналиновый имплант|Adrenaline Implant}} Адреналиновый имплант

[[Файл:Implant.png]]

[[#Adrenaline Implant|Adrenaline Implant]]
| Грудь
| После установки в тело, добавляет вам иконку активации, при нажатии которой полностью снимает оглушение, замедление и восстанавливает стамину, так же вводит в вас смесь стимуляторов которые лечат вас, ускоряют и уменьшают будущие станы. Каждый имплант содержит 3 заряда. Подробнее о веществах [[Руководство_по_фармакологии#Stimulative_agent|тут]].

''Можно получить через [[Руководство_по_Э.К.С.П.Р.И-МЕНТОРу|исследования Э.К.С.П.Р.И-МЕНТОРа]], или же исследовав нелегальные (Illegal) технологии.''

''Имеет три использования, после — отключается.''
|-
| {{Якорь|Имплант свободы|Freedom Implant}} Имплант свободы

[[Файл:Implant.png]]

[[#Freedom Implant|Freedom Implant]]
| Грудь
| Активация этого импланта снимает с носителя наручники, стяжки или любые другие ограничители (например, смирительную рубашку). Немного неочевидный момент — бола входит в их число. Не найдейтесь, что офицеры увидев это будут пытаться нелетально задержать вас второй раз..

''Можно получить через исследования E.X.P.E.R.I-MENTOR, или же исследовав нелегальные (Illegal) технологии.''

''Доступно 4 использования, после — отключается.''
|-
| {{Якорь|Имплант ЭМИ|EMP Implant}} Имплант ЭМИ

[[Файл:Implant.png]]

[[#EMP Implant|EMP Implant]]
| Грудь
| Активация этого импланта создаёт вокруг носителя электростатическое поле, после чего оно высвобождается подобно ЭМИ, отключая все камеры, уничтожая электронику консолей и компьютеров, электризуя двери. Кроме того, кибернетические части, механизированные конечности и импланты будут работать со сбоями (возможно что совсем не будут работать).

Чрезвычайно смертельно для [[КПБ]] или любого члена экипажа с роботизированными органами или конечностями.

''Имеет два заряда, после — отключается.''

Более подробный [[Эффекты от ЭМИ|список целей ЭМИ]].
|-
| {{Якорь|Имплант подчинения|Mindslave Implant}} Имплант подчинения

[[Файл:Implant.png]]

[[#Mindslave Implant|Mindslave Implant]]
| Грудь
| Заставляет носителя полностью подчиняться установившему имплант, пока имплант активен. Не действует, если у члена экипажа уже установлен имплант подчинения, или [[#имплант защиты разума|имплант защиты разума]].

Установка [[#имплант защиты разума|импланта защиты разума]] ПОСЛЕ импланта подчинения — не деактивирует имплант подчинения!
|-
| {{Якорь|Имплант хранилища|Storage Implant}} Имплант хранилища

[[Файл:Implant.png]]

[[#Storage Implant|Storage Implant]]
| Грудь
| Создаёт специальный блюспейс-карман, вмещающий до двух предметов среднего размера (Normal-Sized Item).

''Носитель может получить к карману доступ через кнопку слева вверху экрана.''

Подсказка — в него можно поместить в том числе коробки. А в коробку можно положить другие предметы, таким образом значительно расширив вместимость кармана.
|-
| {{Якорь|Имплант аплинка|Uplink Implant}} Имплант аплинка

[[Файл:Implant.png]]

[[#Uplink Implant|Uplink Implant]]
| Грудь
| При активации даёт носителю доступ к [[аплинк]]у с 10 телекристаллами.

Довольно полезно, если вам не особо нужно тратить ТК для решения задачи, но при этом вы желаете иметь козырь в рукаве на случай поимки.
|}

==Кибернетические имплантаты==

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

{| class="items-table implants colors-Synthetic"
|-
! style="width:15%;" | Предмет
! style="width:15%;" | Место установки
! Описание
|-
| {{Якорь|Антидроп|Anti-Drop Implant}} Антидроп

[[Файл:Antidrop.png]]

[[#Anti-Drop Implant|Anti-Drop Implant]]
| Голова
| При активации блокирует обе руки так, что любой предмет, находящийся в ней, нельзя уронить или снять, даже будучи оглушенным, за исключением ручной деактивации импланта, ЭМИ, удаления импланта или, в крайнем случае, удаления самой конечности.
|-
| {{Якорь|Перезапуск ЦНС|CNS Rebooter}} Перезапуск ЦНС

[[Файл:CNS rebooter.png]]

[[#CNS Rebooter|CNS Rebooter]]
| Голова
| Этот имплант автоматически вернёт носителю контроль над его центральной нервной системой, сократив время стаминакрита максимум до 6 секунд, а так же восстанавливает 9 стамины, если та ниже 60. Несовместим с [[#Нейростимулятор|Нейростимулятором]]. При ЭМИ кладет в стаминакрит на 9 секунд.
|-
| {{Якорь|Нейростимулятор|Neural Jumpstarter}} Нейростимулятор

[[Файл:JumpStarter.png]]

[[#Neural Jumpstarter|Neural Jumpstarter]]
| Голова
| Снимает весь сон и паралич у носителя, когда обнаружит, что тот потерял сознание. Имеет время восстановления в 5 секунд, несовместим с [[#Перезапуск ЦНС|Перезапуском ЦНС]]. ЭМИ кладет в сон на 200 циклов.
|-
| {{Якорь|Кибернетические уши|Cybernetic ears}} Кибернетические уши

[[Файл:Cybernetic Ears.png]]

[[#Cybernetic ears|Cybernetic ears]]
| Голова
| Они работают как обычные уши, но получают большой урон от ЭМИ.
|-
| {{Якорь|Кибернетические глаза|Cybernetic eyes}} Кибернетические глаза

[[Файл:Cyber eyes.png]]

[[#Cybernetic eyes|Cybernetic eyes]]
| Голова
| Они работают как обычные глаза, но получают большой урон от ЭМИ. На них также не влияют генетические эффекты, такие как дальтонизм.
|-
| {{Якорь|Имплант сварочной защиты|Welding Shield Implant}} Имплант сварочной защиты

[[Файл:Eye Implant.png]]

[[#Welding Shield Implant|Welding Shield Implant]]
| Глаза
| Эти микрощитки защищают глаза носителя от вспышек любого рода, не уменьшая обзор. Не полностью защищает, если вы носите имплант термального зрения.
|-
| {{Якорь|Имплант медицинского ИЛС|Medical HUD Implant}} Имплант медицинского ИЛС

[[Файл:Eye Implant.png]]

[[#Medical HUD Implant|Medical HUD Implant]]
| Глаза
| Полностью идентичен очкам c медицинским ИЛС (Medical HUD), позволяя не использовать их.

Виден на портативных и стационарных медицинских сканерах.

Меняет цвет глаз носителя на синий.
|-
| {{Якорь|Имплант охранного ИЛС|Security HUD Implant}} Имплант охранного ИЛС

[[Файл:Eye Implant.png]]

[[#Security HUD Implant|Security HUD Implant]]
| Глаза
| Полностью идентичен очкам с охранным ИЛС (Security HUD), позволяя не использовать их.

Виден на портативных и стационарных медицинских сканерах.

Меняет цвет глаз носителя на красный.
|-
| {{Якорь|Имплант мезонного сканера|Meson scanner Implant}} Имплант мезонного сканера

[[Файл:Eye Implant.png]]

[[#Meson scanner Implant|Meson scanner Implant]]
| Глаза
| Дают носителю возможность видеть стены и пол вне зависимости от наличия стен, повышает общую гамму зрения в темноте, полезен для [[инженер]]ов и [[шахтер]]ов.
|-
| {{Якорь|Имплант диагностического ИЛС|Diagnostic HUD Implant}} Имплант диагностического ИЛС

[[Файл:Eye Implant.png]]

[[#Diagnostic HUD Implant|Diagnostic HUD Implant]]
| Глаза
| Полностью идентичен очкам с диагностическим ИЛС (Diagnostic HUD), позволяя не использовать их.

Виден на портативных и стационарных медицинских сканерах.

Меняет цвет глаз носителя на коричневый.
|-
| {{Якорь|Рентгеновский имплант|X-ray Implant}} Рентгеновский имплант

[[Файл:Eye Implant.png]]

[[#X-ray Implant|X-ray Implant]]
| Глаза
| Этот имплант даст носителю рентгеновское зрение (так же, как и рентгеновский ген).
|-
| {{Якорь|Оптический термальный имплант|Optical Thermal Implants}} Оптический термальный имплант

[[Файл:Eye Implant.png]]

[[#Optical Thermal Implants|Optical Thermal Implants]]
| Глаза
| Этот имплант даст носителю тепловое зрение сквозь стены и прочие объекты, позволяющее видеть живых существ за ними. Увеличивает уязвимость к вспышкам для глаз.
|-
| {{Якорь|Имплант дыхательной трубки|Breathing Tube Implant}} Имплант дыхательной трубки

[[Файл:Breathing tube.png]]

[[#Breathing Tube Implant|Breathing Tube Implant]]
| Рот
| Позволяет использовать баллоны без маски и защищает носителя от удушения руками/гарротой.
|-
| {{Якорь|Кибернетическое сердце|Cybernetic Heart}} Кибернетическое сердце

[[Файл:Cybernetic heart.gif]]

[[#Cybernetic Heart|Cybernetic Heart]]
| Грудь
| Электронное устройство, имитирующее функции человеческого сердца. Может остановится от воздействия ЭМИ.
|-
| {{Якорь|Улучшенное кибернетическое сердце|Upgraded Cybernetic Heart}} Улучшенное кибернетическое сердце

[[Файл:Upgraded Cybernetic Heart.gif]]

[[#Upgraded Cybernetic Heart|Upgraded Cybernetic Heart]]
| Грудь
| Улучшенное сердце, которое предоставляет следующие эффекты людям(не работает на КПБ):
*При выявлении остановки сердца каждые 3 секунды пытается с 10% вероятностью запустить его. Перезарядка при успехе: 30 секунд.
*При выявлении сердечной недостаточности каждые 3 секунды пытается с вероятностью 25% исправить её. Перезарядка при успехе: 30 секунд.
*Убирает сон, уменьшает за цикл время (в скобках указан эффект, если сердце емагнуто):
** Сонливости, на 8(16) секунд.
** Паралича, на 2(4) секунды.
** Оглушения, на 2(4) секунды.
** Ослабления, на 2(4) секунды.
* Также восстанавливает 1(2, если емагнут) единиц стамины за цикл.

Можно [[E-maggable objects|емагнуть]], чтобы удвоить шансы на излечение недостаточности и остановки, уменьшить перезарядку на 10 секунд, улучшить восстановление выносливости и уменшение негативных эффектов, но добавить шанс выйти из строя при ударе током.

Точные эффекты при ударе дефибриллятором:
*Обычное сердце:
5% - вызов сердечной недостаточности.

10% - вызов спазмов, наносящих 10 урона от <font color="red">травм</font> или <font color="orange">ожогов</font>.
*Взломанное сердце:
20% - вызов болезненных спазмов, наносящих 20 урона от <font color="red">травм</font> или <font color="orange">ожогов</font>.

10% - вызов сердечной недостаточности или остановки сердца.

5% - некроз сердца.

Обратите внимание, что получение шока от электризованной двери уменьшает шансы вдвое, а получение оглушающей дубинкой или тазером - втрое.

ЭМИ на улучшенное сердце в любом состоянии вызывает некроз органа.
|-
| {{Якорь|Кибернетические легкие|Cybernetic Lungs}} Кибернетические легкие

[[Файл:Cybernetic Lungs.png]]

[[#Cybernetic Lungs|Cybernetic Lungs]]
| Грудь
| Электронное устройство, имитирующее функции пары человеческих легких. Также работает в отношении воксов и плазмаменов дышащих токсичным для них газом, если изменить настройки мультитулом. Наносит 20 урона <font color="blue">гипоксией</font> и ненадолго валит с ног от воздействия ЭМИ.
|-
| {{Якорь|Улучшенные кибернетические легкие|Upgraded Cybernetic Lungs}} Улучшенные кибернетические легкие

[[Файл:Upgraded Cybernetic Lungs.png]]

[[#Upgraded Cybernetic Lungs|Upgraded Cybernetic Lungs]]
| Грудь
| Более продвинутая версия [[#Кибернетические легкие|кибернетических легких]]. Они повышают порог невосприимчивости к <font color="green">токсинам</font> и углекислому газу в окружающей атмосфере. Понижает порог получения урона от холода до 200K, позволяя практически всем расам кроме [[врин]]ов и [[драск]]ов чувствовать себя лучше на холоде. Наносит 20 урона <font color="blue">гипоксией</font> и ненадолго валит с ног от воздействия ЭМИ.
|-
| {{Якорь|Кибернетическая печень|Cybernetic Liver}} Кибернетическая печень

[[Файл:Cybernetic Liver.png]]

[[#Cybernetic Liver|Cybernetic Liver]]
| Пах
| Электронное устройство, имитирующее функции печени. Имеет базовый модификатор [[Руководство_по_еде_и_напиткам#Напитки_и_опьянение|опъянения]] в 1.
|-
| {{Якорь|Кибернетические почки|Cybernetic Kidneys}} Кибернетические почки

[[Файл:Cybernetic Kidneys.png]]

[[#Cybernetic Kidneys|Cybernetic Kidneys]]
| Пах
| Электронное устройство, имитирующее функции пары почек.
|-
| {{Якорь|Имплант питающей помпы|Nutriment Pump Implant}} Имплант питающей помпы

[[Файл:Nutriment pump implant.png]]

[[#Nutriment Pump Implant|Nutriment Pump Implant]]
| Грудь
| Когда носитель сильно голодает, этот имплант будет синтезировать и закачивать в его кровоток небольшое количество питательных веществ. При получении ЭМИ заражает пищевым отравлением и оглушает вводом 5-10 юнитов [[Руководство_по_фармакологии#????|????]] в кровь.
|-
| {{Якорь|Имплант питающей помпы ПЛЮС|Nutriment Pump Implant PLUS}} Имплант питающей помпы ПЛЮС

[[Файл:Nutriment pump implant PLUS.png]]

[[#Nutriment Pump Implant PLUS|Nutriment Pump Implant PLUS]]
| Грудь
| Эта улучшенная версия [[#Имплант питающей помпы|питающей помпы]], закачивающая в кровоток на отметке, когда уже хочется кушать, а не при сильном голоде. При получении ЭМИ ввод [[Руководство_по_фармакологии#????|????]] в кровоток увеличен вдвое.
|-
| {{Якорь|Оживляющий имплант|Reviver Implant}} Оживляющий имплант

[[Файл:Reviver.png]]

[[#Reviver Implant|Reviver Implant]]
| Грудь
| В критическом состоянии лечит каждый тип урона на <font color="blue">3</font>/<font color="red">1</font>/<font color="orange">1</font>/<font color="green">1</font> урона с отдельным таймером 3-8 секунд на каждое лечение урона. Единоразово запускает сердце вновь, если остановилось.
При ЭМИ импульсе вызывает остановку сердца и уводит имплант на восстановление в 20 секунд.
|-
| {{Якорь|Хирургический имплант|Surgical Arm Implant}} Хирургический имплант

[[Файл:Arm implant small.png]]

[[#Surgical Arm Implant|Surgical Arm Implant]]
| Рука
| Набор хирургических инструментов, спрятанный за панелью на руке носителя. Нажмите Z в пустой руке, куда установлен имплант, дабы вызвать панель вызова инструментов. Нажмите Q, чтобы убрать инструмент обратно в руку.

Инструменты в импланте работают в 2 раза быстрее обычных инструментов. Хирургическая пила из этого набора наносит 10 урона от <font color="red">травм</font> вместо 15 у "оригинала". Как и обычную пилу, можно заточить.
|-
| {{Якорь|Инструментальный имплант|Toolset Arm Implant}} Инструментальный имплант

[[Файл:Arm implant small.png]]

[[#Toolset Arm Implant|Toolset Arm Implant]]
| Рука
| Урезанная версия набора инструментов инженерного [[киборг]]а, предназначенная для установки в руку пациента. Содержит базовые инструменты, работающие в 2 раза быстрее обычных.

Можно [[E-maggable objects|емагнуть]], открыв для доступа боевой нож, наносящий 20 урона от <font color="red">травм</font> и поддающийся заточке.
|-
| {{Якорь|Клинки богомола ШеллГуард|ShellGuard Mantis Blade}} Клинки богомола ШеллГуард

[[Файл:Mantis.png|64px]]

[[#ShellGuard Mantis Blade|ShellGuard Mantis Blade]]
| Рука
| Скрытый клинок компании ShellGuard. Наносит 15 урона, имеет 20% пробития и 20% блока. При наличии имплантов в обоих руках, на Harm бьёт сразу обоими руками.
|-
| {{Якорь|Имплант лазерной пушки|Laser Arm Implant}} Имплант лазерной пушки

[[Файл:Лазер имплант.png]]

[[#Laser Arm Implant|Laser Arm Implant]]
| Рука
| Вставляет вам в руку красиво выглядящий лазерный пистолет, по характеристикам полностью копирующий антикварную пушку капитана: 23 заряда и очень быстрая самозарядка!
|-
| {{Якорь|Уборочный имплант|Janitorial Toolset Implant}} Уборочный имплант

[[Файл:Arm implant small.png]]

[[#Janitorial Toolset Implant|Janitorial Toolset Implant]]
| Рука
| Набор инструментов для уборки, спрятанный за панелью на руке носителя. Содержит заменитель ламп, супершвабру, обычное мыло, голопроектор уборщика и спрей с 250 космического очистителя.
|-
| {{Якорь|Ботанический имплант|Botanical Toolset Implant}} Ботанический имплант

[[Файл:Arm implant small.png]]

[[#Botanical Toolset Implant|Botanical Toolset Implant]]
| Рука
| Набор ботанических инструментов, спрятанных за панелью на руке носителя. Содержит топорик, лопатку, культиватор, анализатор растений, ключ и кусачки.
|-
| {{Якорь|Имплант для взлома|Hacking Arm Implant}} Имплант для взлома

[[Файл:Arm implant small.png]]

[[#Hacking Arm Implant|Hacking Arm Implant]]
| Рука
| Небольшой имплант в руку, содержащий усовершенствованную отвертку, кусачки и мультитул пришельцев, разработанный для [[инженер]]ов и полевой работы с механизмами. На самом деле полностью легален, несмотря на то, что название может заставить вас подумать об обратном.
|-
| {{Якорь|Комический имплант|Comical implant}} Комический имплант

[[Файл:CNS rebooter small.png]]

[[#Comical implant|Comical implant]]
| Голова
| Этот имплант сделает вас настоящим [[Клоун|клоуном]]! Ваши сообщения в чате начинают писаться в шрифте Comic Sans. [[КПБ]]-клоуны появляются с встроенным имплантом.
|-
| {{Якорь|Боевое обновление КПБ|IPC combat upgrade}} Боевое обновление КПБ

[[Файл:IPC combat upgrade.png]]

[[#IPC combat upgrade|IPC combat upgrade]]
| Загружается напрямую в мозг
| Боевое искусство для [[КПБ]].

Позволяет легче обезвреживать угрозы и позволяет проводить дефибрилляцию при реанимации. Подробнее о приемах [[Боевые_искусства#Эксклюзивное_боевое_искусство_для_КПБ|тут]].
|}

==Органические импланты==

{| class="items-table implants colors-Abductor"
|-
! style="width:15%;" | Предмет
! style="width:15%;" | Место установки
! Описание
|-
| {{Якорь|Термальные рецепторы|Thermal Receptors}} Термальные рецепторы

[[Файл:Thermal Receptors.png]]

[[#Thermal Receptors|Thermal Receptors]]
| Глаза
| Может быть извлечен только из [[генокрад]]а, обладающего способностью [[Генокрад#Augmented_Eyesight|аугментированное зрение]] и включившего эту способность. При удалении и имплантации в другого человека дает ему постоянное термальное зрение, пока орган не будет удален.

Может быть обнаружен при полном сканировании тела. Имейте в виду, если [[генокрад]] отключает эту способность, тепловые рецепторы превращаются в защитные мембраны, которые вместо термального зрения дают защиту от вспышек. Кроме того, [[генокрад]] без способности [[Генокрад#Augmented_Eyesight|аугментированное зрение]] не обладают этими органами.
|-
| {{Якорь|Горящие красные глаза|Burning Red Eyes}} Горящие красные глаза

[[Файл:Burning Red Eyes.png]]

[[#Burning Red Eyes|Burning Red Eyes]]
| Глаза
| Могут быть получены от [[тенеморф]]а. Дают носителю ночное зрение.
|-
| {{Якорь|Божественные голосовые связки|Divine Vocal Chords}} Божественные голосовые связки

[[Файл:Voice Of God.png]]

[[#Divine Vocal Chords|Divine Vocal Chords]]
| Рот
| Эти голосовые связки, полученные от мёртвого [[Руководство по шахтёрскому ремеслу#Colossus|Колосса]] , позволяют носителю использовать [[Глас Бога]].

|-

| {{Якорь|Xeno plasma vessel|Xeno plasma vessel}} Сосуд с плазмой

[[Файл:Плпзмо-почки.png]]

[[#Xeno plasma vessel|Xeno plasma vessel]]
| Грудь
| Орган, полученный из тела [[ксеноморф]]а, позволяет вырабатывать плазму и создавать сорняки ксеноморфов. '''ВСЕ''' сорняки лечить носителя.
|-

| {{Якорь|Xeno hive node|Xeno hive node}} Связь с ульем

[[Файл:Хайва.png]]

[[#Xeno hive node|Xeno hive node]]
| Голова
| Орган, полученный из тела [[ксеноморф]]а, обучает телепатическому общению ксеноморфов, а также носитель начинает принадлежать "фракции" ксеноморфов.

|-

| {{Якорь|Xeno neurotoxin gland|Xeno neurotoxin gland}} Нейротоксиновые железы

[[Файл:Нейротоксин.png]]

[[#Xeno neurotoxin gland|Xeno neurotoxin gland]]
| Голова
| Орган, полученный из тела [[ксеноморф]]а, позволяет носителю стрелять кислотными снарядами изо рта. При попадании наносят 30 урона ожогами.

|-

| {{Якорь|Xeno acid gland|Xeno acid gland}} Кислотные железы

[[Файл:Кислотные железы.png]]

[[#Xeno acid gland|Xeno acid gland]]
| Голова
| Орган, полученный из тела [[ксеноморф]]а, позволяет носителю плюнуть на объект или существо кислотой, которая начнет медленно разъедать поражённую поверхность.

|-

| {{Якорь|Xeno resin organ|Xeno resin organ}} Смоляные выделения

[[Файл:ксено-строительство.png]]

[[#Xeno resin organ|Xeno resin organ]]
| Рот
| Орган, полученный из тела [[ксеноморф]]а, "обучает" носителя "строительству" ксеноморфов. Носитель может создавать специальные стены, двери, мембраны и кровати ксеноморфов.

|-

| {{Якорь|Xeno egg sac|Xeno egg sac}} Откладка яиц

[[Файл:блять фу нахуй.png]]

[[#Xeno egg sac|Xeno egg sac]]
| Ass
| Орган, полученный из тела королевы [[Ксеноморф|ксеноморфов]], вшивается <s>в жо...</s> в толстую кишку или ее подобие, позволяет "создавать" яйца, ну и мерзость.
|}

==СРП имплантов==

{{СРП:Импланты}}

Руководство по разработке

2023-10-29T09:27:53Z

Vladisvell: /* Руководство по началу работы с TGUI */ - Добавил перенос строки

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code для удобного редактирования и отладки кода.]]
* [[#Установка и настройка Github|Настройка GitHub для начала работы с билдом.]]

=== Взаимодействие с Git ===
* [[#Настройка и использование Github Desktop|Установка и использование Github Desktop (Дружелюбно к новичкам)]]
* [[#Установка и использование TortoiseGit|(Альтернативно) Установка и использование TortoiseGit (Поддерживает работу с Git через контекстное меню Windows)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Запуск локальной версии билда ===
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon? (Не рекомендуется для отладки, но есть возможность запуска сервера на несколько игроков)]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через Visual Studio Code? (Рекомендуется для отладки, не поддерживает мультиплеер)]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Маппинг (Редактирование карт) ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]

=== Спрайтинг ===
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== TGUI (Красивые интерфейсы внутри игры) ===
* [[#Руководство по началу работы с TGUI|Как начать работу с TGUI]]
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]

=== Дополнительно ===
* [[Как делать перевод игры]]?

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>bugfix: Исправлена ошибка с X, когда вы Y
tweak: усилен X, чтобы наносить Y больше урона. </pre>
Старайтесь вкратце, желательно на английском, делать заголовок Pull Request'а.
Название заголовка есть "тег: краткое описание", например: '''bugfix: now table climbs do not cause server crash'''.
В данный момент журнал изменений отображается внтури игры. Там Вы, и любой другой игрок, можете ознакомиться с обновлениями.

Какие теги ставить перед Вашим PR:
* bugfix: если Вы исправили некий баг
* add: если Вы добавили новую фичу
* imageadd: если просто поменяли спрайты, без затрагивания кода
* soundadd: если просто добавили новые звуки, без затрагивания кода
* tweak: если Вы сделали незначительную правку (например изменили одно число на другое)
* balance: то же что и tweak, но когда изменений множество
* refactor: если Вы полностью переписали старый код, улучшив его, НО не изменив функционал
* qol: если Ваше изменение не влияет на баланс, а только улучшает взаимодействие между игрой и игроком
* wip: если Ваш PR в драфте и планируется длительная разработка (можно не ставить)

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

===Как сделать хорошую демонстрацию изменений===
ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Нажмите ПКМ по рабочей папке. Выберите '''TortoiseGit''', затем '''Push...'''
* Задайте '''Local''' и '''Remote''' имя ветки, в которую вы совершили коммиты ранее (например My_First_Branch)
* Под Destination, задайте Remote: to '''origin'''.
* Нажмите '''Ok'''. Это отправит изменения на удаленный репозиторий (На гитхабе).
* Зайдите в свой репозиторий (пример https://github.com/NAME/Paradise)
* Нажмите '''Pull Request''' справа сверху.
* Создайте Pull Request, следуя инструкциям из пресозданного шаблона.
* Получилось! Во многих случаях будут обнаружены ошибки, которые будут выделены другими участниками сообщества, merge-conflict'ы и другие вещи, что заставит Вас посещать Pull Request вновь.
* Опционально, загляните в раздел Clean Commits для руководства по чистым коммитам, '''которые помогают мейнтейнерам легче проводить ревью!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS v12.13+''' (на данный момент v12.22.12)
* https://nodejs.org/en/download/, раздел с дистрибутивами для '''v12.x''' находится по ссылке https://nodejs.org/dist/latest-v12.x/ (выбираете подходящее)
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x64.msi для Windows x64
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x86.msi для Windows x86
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.

Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-29T08:25:03Z

Vladisvell: Добавлены текущие положения относительно Pull Request'ов на момент 29.10.2023

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code для удобного редактирования и отладки кода.]]
* [[#Установка и настройка Github|Настройка GitHub для начала работы с билдом.]]

=== Взаимодействие с Git ===
* [[#Настройка и использование Github Desktop|Установка и использование Github Desktop (Дружелюбно к новичкам)]]
* [[#Установка и использование TortoiseGit|(Альтернативно) Установка и использование TortoiseGit (Поддерживает работу с Git через контекстное меню Windows)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Запуск локальной версии билда ===
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon? (Не рекомендуется для отладки, но есть возможность запуска сервера на несколько игроков)]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через Visual Studio Code? (Рекомендуется для отладки, не поддерживает мультиплеер)]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Маппинг (Редактирование карт) ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]

=== Спрайтинг ===
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== TGUI (Красивые интерфейсы внутри игры) ===
* [[#Руководство по началу работы с TGUI|Как начать работу с TGUI]]
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]

=== Дополнительно ===
* [[Как делать перевод игры]]?

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>bugfix: Исправлена ошибка с X, когда вы Y
tweak: усилен X, чтобы наносить Y больше урона. </pre>
Старайтесь вкратце, желательно на английском, делать заголовок Pull Request'а.
Название заголовка есть "тег: краткое описание", например: '''bugfix: now table climbs do not cause server crash'''.
В данный момент журнал изменений отображается внтури игры. Там Вы, и любой другой игрок, можете ознакомиться с обновлениями.

Какие теги ставить перед Вашим PR:
* bugfix: если Вы исправили некий баг
* add: если Вы добавили новую фичу
* imageadd: если просто поменяли спрайты, без затрагивания кода
* soundadd: если просто добавили новые звуки, без затрагивания кода
* tweak: если Вы сделали незначительную правку (например изменили одно число на другое)
* balance: то же что и tweak, но когда изменений множество
* refactor: если Вы полностью переписали старый код, улучшив его, НО не изменив функционал
* qol: если Ваше изменение не влияет на баланс, а только улучшает взаимодействие между игрой и игроком
* wip: если Ваш PR в драфте и планируется длительная разработка (можно не ставить)

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

===Как сделать хорошую демонстрацию изменений===
ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Нажмите ПКМ по рабочей папке. Выберите '''TortoiseGit''', затем '''Push...'''
* Задайте '''Local''' и '''Remote''' имя ветки, в которую вы совершили коммиты ранее (например My_First_Branch)
* Под Destination, задайте Remote: to '''origin'''.
* Нажмите '''Ok'''. Это отправит изменения на удаленный репозиторий (На гитхабе).
* Зайдите в свой репозиторий (пример https://github.com/NAME/Paradise)
* Нажмите '''Pull Request''' справа сверху.
* Создайте Pull Request, следуя инструкциям из пресозданного шаблона.
* Получилось! Во многих случаях будут обнаружены ошибки, которые будут выделены другими участниками сообщества, merge-conflict'ы и другие вещи, что заставит Вас посещать Pull Request вновь.
* Опционально, загляните в раздел Clean Commits для руководства по чистым коммитам, '''которые помогают мейнтейнерам легче проводить ревью!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS v12.13+''' (на данный момент v12.22.12)
* https://nodejs.org/en/download/, раздел с дистрибутивами для '''v12.x''' находится по ссылке https://nodejs.org/dist/latest-v12.x/ (выбираете подходящее)
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x64.msi для Windows x64
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x86.msi для Windows x86
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.
Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-29T07:57:39Z

Vladisvell: /* Создание Pull Request */ Перевод для TortoiseGit

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code для удобного редактирования и отладки кода.]]
* [[#Установка и настройка Github|Настройка GitHub для начала работы с билдом.]]

=== Взаимодействие с Git ===
* [[#Настройка и использование Github Desktop|Установка и использование Github Desktop (Дружелюбно к новичкам)]]
* [[#Установка и использование TortoiseGit|(Альтернативно) Установка и использование TortoiseGit (Поддерживает работу с Git через контекстное меню Windows)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Запуск локальной версии билда ===
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon? (Не рекомендуется для отладки, но есть возможность запуска сервера на несколько игроков)]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через Visual Studio Code? (Рекомендуется для отладки, не поддерживает мультиплеер)]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Маппинг (Редактирование карт) ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]

=== Спрайтинг ===
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== TGUI (Красивые интерфейсы внутри игры) ===
* [[#Руководство по началу работы с TGUI|Как начать работу с TGUI]]
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]

=== Дополнительно ===
* [[Как делать перевод игры]]?

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Нажмите ПКМ по рабочей папке. Выберите '''TortoiseGit''', затем '''Push...'''
* Задайте '''Local''' и '''Remote''' имя ветки, в которую вы совершили коммиты ранее (например My_First_Branch)
* Под Destination, задайте Remote: to '''origin'''.
* Нажмите '''Ok'''. Это отправит изменения на удаленный репозиторий (На гитхабе).
* Зайдите в свой репозиторий (пример https://github.com/NAME/Paradise)
* Нажмите '''Pull Request''' справа сверху.
* Создайте Pull Request, следуя инструкциям из пресозданного шаблона.
* Получилось! Во многих случаях будут обнаружены ошибки, которые будут выделены другими участниками сообщества, merge-conflict'ы и другие вещи, что заставит Вас посещать Pull Request вновь.
* Опционально, загляните в раздел Clean Commits для руководства по чистым коммитам, '''которые помогают мейнтейнерам легче проводить ревью!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS v12.13+''' (на данный момент v12.22.12)
* https://nodejs.org/en/download/, раздел с дистрибутивами для '''v12.x''' находится по ссылке https://nodejs.org/dist/latest-v12.x/ (выбираете подходящее)
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x64.msi для Windows x64
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x86.msi для Windows x86
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.
Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T22:33:38Z

Vladisvell: Изменены пункты списка для соответствия содержимому

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code для удобного редактирования и отладки кода.]]
* [[#Установка и настройка Github|Настройка GitHub для начала работы с билдом.]]

=== Взаимодействие с Git ===
* [[#Настройка и использование Github Desktop|Установка и использование Github Desktop (Дружелюбно к новичкам)]]
* [[#Установка и использование TortoiseGit|(Альтернативно) Установка и использование TortoiseGit (Поддерживает работу с Git через контекстное меню Windows)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Запуск локальной версии билда ===
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon? (Не рекомендуется для отладки, но есть возможность запуска сервера на несколько игроков)]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через Visual Studio Code? (Рекомендуется для отладки, не поддерживает мультиплеер)]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Маппинг (Редактирование карт) ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]

=== Спрайтинг ===
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== TGUI (Красивые интерфейсы внутри игры) ===
* [[#Руководство по началу работы с TGUI|Как начать работу с TGUI]]
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]

=== Дополнительно ===
* [[Как делать перевод игры]]?

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS v12.13+''' (на данный момент v12.22.12)
* https://nodejs.org/en/download/, раздел с дистрибутивами для '''v12.x''' находится по ссылке https://nodejs.org/dist/latest-v12.x/ (выбираете подходящее)
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x64.msi для Windows x64
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x86.msi для Windows x86
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.
Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T22:25:57Z

Vladisvell: Добавлено уточнение для способов запуска локалок.

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Мне нужно установить\настроить VS Code]]
* [[#Установка и настройка Github|Мне нужно настроить Git/Github]]
* [[#Настройка и использование Github Desktop|Я хочу использовать Github Desktop (Дружелюбно к новичкам)]]
* [[#Установка и использование TortoiseGit|Я хочу использовать TortoiseGit (Не для новичков) (Поддерживает работу с Git через контекстное меню Windows)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Запуск локальной версии билда ===
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon? (Не рекомендуется для отладки, но есть возможность запуска сервера на несколько игроков)]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через Visual Studio Code? (Рекомендуется для отладки, не поддерживает мультиплеер)]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Маппинг (Редактирование карт) ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]

=== Спрайтинг ===
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== TGUI (Красивые интерфейсы внутри игры) ===
* [[#Руководство по началу работы с TGUI|Как начать работу с TGUI]]
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]

=== Дополнительно ===
* [[Как делать перевод игры]]?

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS v12.13+''' (на данный момент v12.22.12)
* https://nodejs.org/en/download/, раздел с дистрибутивами для '''v12.x''' находится по ссылке https://nodejs.org/dist/latest-v12.x/ (выбираете подходящее)
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x64.msi для Windows x64
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x86.msi для Windows x86
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.
Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T22:23:56Z

Vladisvell: Расширение, реструктуризация разделов быстрой навигации

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Мне нужно установить\настроить VS Code]]
* [[#Установка и настройка Github|Мне нужно настроить Git/Github]]
* [[#Настройка и использование Github Desktop|Я хочу использовать Github Desktop (Дружелюбно к новичкам)]]
* [[#Установка и использование TortoiseGit|Я хочу использовать TortoiseGit (Не для новичков) (Поддерживает работу с Git через контекстное меню Windows)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Запуск локальной версии билда ===
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon?]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через Visual Studio Code?]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Маппинг (Редактирование карт) ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]

=== Спрайтинг ===
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== TGUI (Красивые интерфейсы внутри игры) ===
* [[#Руководство по началу работы с TGUI|Как начать работу с TGUI]]
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]

=== Дополнительно ===
* [[Как делать перевод игры]]?

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS v12.13+''' (на данный момент v12.22.12)
* https://nodejs.org/en/download/, раздел с дистрибутивами для '''v12.x''' находится по ссылке https://nodejs.org/dist/latest-v12.x/ (выбираете подходящее)
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x64.msi для Windows x64
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x86.msi для Windows x86
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.
Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T22:14:14Z

Vladisvell: Устранение опечаток

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Мне нужно установить\настроить VS Code]]
* [[#Установка и настройка Github|Мне нужно настроить Git/Github]]
* [[#Настройка и использование Github Desktop|Я хочу использовать Github Desktop (Дружелюбно к новичкам)]]
* [[#Setting up & Using TortoiseGit|Я хочу использовать TortoiseGit (Не для новичков)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Работа с редакторами ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== Дополнительно ===
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]
* [[Как делать перевод игры]]?
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon?]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через VSC?]]

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS v12.13+''' (на данный момент v12.22.12)
* https://nodejs.org/en/download/, раздел с дистрибутивами для '''v12.x''' находится по ссылке https://nodejs.org/dist/latest-v12.x/ (выбираете подходящее)
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x64.msi для Windows x64
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x86.msi для Windows x86
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.
Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T22:12:42Z

Vladisvell: /* Руководство по началу работы с TGUI */ - Добавление информации

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Мне нужно установить\настроить VS Code]]
* [[#Установка и настройка Github|Мне нужно настроить Git/Github]]
* [[#Настройка и использование Github Desktop|Я хочу использовать Github Desktop (Дружелюбно к новичкам)]]
* [[#Setting up & Using TortoiseGit|Я хочу использовать TortoiseGit (Не для новичков)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Работа с редакторами ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== Дополнительно ===
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]
* [[Как делать перевод игры]]?
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon?]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через VSC?]]

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==
Для начала работы с TGUI в билде Paradise (Актуально на момент 27.10.2023)

* Внимательно читайте инструкцию, расположенную файле README.md внутри папки tgui билда для уточнения спорных моментов.
* Инструкции ниже проверены на версии '''Windows 10 x64 2004'''
* Установите '''NodeJS v12.13+''' (на данный момент v12.22.12)
* [Сайт NodeJS](https://nodejs.org/en/download/), раздел с дистрибутивом для '''v12.x''' https://nodejs.org/dist/latest-v12.x/ (выбираете подходящее)
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x64.msi для Windows x64
* Пример https://nodejs.org/dist/latest-v12.x/node-v12.22.12-x86.msi для Windows x86
* Установите '''Yarn v1.19+''' https://yarnpkg.com/en/docs/install
* https://github.com/yarnpkg/yarn/releases/tag/v1.19.2 ссылка на версию '''1.19.2'''
* https://github.com/yarnpkg/yarn/releases/download/v1.19.2/yarn-1.19.2.msi ссылка на скачивание версии '''1.19.2''' для '''ОС Windows'''

Внутри VSCode (или командной строки, запущенной в корневой папке билда) пропишите '''cd tgui''', затем '''yarn watch''' для отслеживания изменений внутри JS файлов интерфейсов TGUI и мгновенного отображения их в игре.
Для компиляции TGUI запустите '''tgui-build.bat''' в папке '''tgui/bin'''

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T22:10:09Z

Vladisvell: /* Учимся использовать TGUI */

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Мне нужно установить\настроить VS Code]]
* [[#Установка и настройка Github|Мне нужно настроить Git/Github]]
* [[#Настройка и использование Github Desktop|Я хочу использовать Github Desktop (Дружелюбно к новичкам)]]
* [[#Setting up & Using TortoiseGit|Я хочу использовать TortoiseGit (Не для новичков)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Работа с редакторами ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== Дополнительно ===
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]
* [[Как делать перевод игры]]?
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon?]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через VSC?]]

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

== Руководство по началу работы с TGUI ==

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T10:13:16Z

Vladisvell: Перевод гайда по созданию коммитов с TortoiseGit, добавлено уточнение о том, что такое TortoiseGit

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Мне нужно установить\настроить VS Code]]
* [[#Установка и настройка Github|Мне нужно настроить Git/Github]]
* [[#Настройка и использование Github Desktop|Я хочу использовать Github Desktop (Дружелюбно к новичкам)]]
* [[#Setting up & Using TortoiseGit|Я хочу использовать TortoiseGit (Не для новичков)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Работа с редакторами ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== Дополнительно ===
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]
* [[Как делать перевод игры]]?
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon?]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через VSC?]]

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==
TortoiseGit - вариант взаимодействия с Git со встроенными в контекстное меню проводника Windows возможностями.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* Коммит - это подтвержденное изменение файлов в Вашем репозитории, т.е фиксация изменений файлов. Старайтесь не делать коммит без подтверждения работоспособности (однако ошибки могут быть исправлены последующими коммитами.)
* Как было сказано ранее, Вы должны использовать разные ветки для разделения коммитов/изменений. '''Не совершайте коммит в master (master220). Эта ветка должна быть чистой, чтобы Вы могли к ней откатиться, если это требуется.'''
* Для создания коммитов, Вы должны отредактировать файлы, используя инструменты BYOND (для спрайтов, кода), VScode (для кода), StrongDMM (для маппинга). Убедитесь, что ваш код не идёт вразрез со стандартами. Когда вы закончили, нажмите ПКМ по рабочей папке и выберите '''Git Commit -> "[Имя Вашей Ветки]"'''
* Затем Вы сможете выбрать файлы, которые будут в коммите отмечая, или снимая отметку с них. Также стоит писать детальное описание коммита, объясняющее, что конкретно изменено в коммите.
* Нажмите '''Commit''' и коммит будет занесён в Вашу ветку в локальном репозитории.
* Заметка: Если там написано "Commit & Push", есть стрелка рядом с кнопкой, с помощью которой можно выбрать пункт '''Commit'''

===Создание Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T05:13:01Z

Vladisvell: Частичный перевод и дополнение инструкций по установке и работе с TortoiseGit.

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Мне нужно установить\настроить VS Code]]
* [[#Установка и настройка Github|Мне нужно настроить Git/Github]]
* [[#Настройка и использование Github Desktop|Я хочу использовать Github Desktop (Дружелюбно к новичкам)]]
* [[#Setting up & Using TortoiseGit|Я хочу использовать TortoiseGit (Не для новичков)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Работа с редакторами ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== Дополнительно ===
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]
* [[Как делать перевод игры]]?
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon?]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через VSC?]]

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Установка и использование TortoiseGit==

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском (частично переведено). Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

Если Вы ещё не установили Git Bash, сделайте это для корректной настройки TortoiseGit.
Руководство рабочее на момент 28.10.2023

* Зайдите на сайт: http://code.google.com/p/tortoisegit/wiki/Download
* Скачайте версию TortoiseGit, подходящую под Вашу операционную систему.
* Запустите установочный файл
* В пункте "Choose SSH Client" выберите "Open SSH, Git default SSH Client."
* После завершения установки программа предложит запустить мастер настройки, соглашаемся, отметив "Run first start wizard", затем Finish.
* (Опционально) Можно скачать локализацию для TortoiseGit, однако рекомендуется использовать английскую версию данной программы.
* В пункте "Configure git.exe", если Вы уже установили ранее Git Bash, нажмите "Check Now", слева должно появиться "git version ..." (например git version 2.42.0.windows.2), нажимаем Далее.
* '''Перезапустите компьютер для полноценной работы TortoiseGit.'''

===Создание форка билда===
Смотрите [[#Forking ParaCode|сюда]]

===Скачивание кода билда===
* Найдите место, где будет расположен код билда.
* Щелкните ПКМ по выбранной папке и нажмите '''Git Clone...'''
* Поле URL должно быть отмечено ссылкой на ваш форк (например https://github.com/{username}/Paradise.git)
* Нажмите Next и наблюдайте, как летающие черепахи переносят билд на Ваш компьютер.

===Настройка TortoiseGit===
* Нажмите ПКМ '''на созданную папку''' (обычно называется Paradise), перейдите к '''TortoiseGit''' и нажмите '''Settings'''.
* Нажмите на '''Remote''' под '''Git'''.
* Там должен быть список удаленных репозиториев, например: '''origin'''.
* Теперь нужно добавить главный репозиторий:
* В окне '''Remote''' пропишите '''upstream'''.
* В окне '''URL:''' пропишите: https://github.com/ss220-space/Paradise.git
* Нажмите '''Add New/Save'''.
* Вам может быть предложено добавить ветки с новодобавленного удаленного репозитория ("Do you want to fetch remote branches from the newly added remote?"), соглашаемся.
* В окне устанавливаем "Remote" на upstream, жмём OK.
* Теперь у вас есть актуальная версия билда.
* Почти всё!

===Обновляем Ваш Репозиторий===
* Перед работой с чем-либо убедитесь, что Ваш билд находится в одной точке развития с основным.
* Нажмите ПКМ по папке репозитория, потом '''TortoiseGit''', затем '''Pull'''.
* В выпадающем списке '''Remote''' выберите '''upstream''' (или как Вы его обозначили)
* '''remote branch''' назначена на '''master'''. (или master220 в нашем случае)
* Нажмите '''Ok'''. Изменения из удаленного репозитория попадут на Ваш компьютер.

===Создание ветки (Branching)===

Ветвление репозитория крайне важно для организации Ваших коммитов, и для каждого отдельного изменения должна быть создана отдельная ветка (Например, если Вы хотите изменить спрайт предмета, и за одно пофиксить баг - эти изменения должны быть в отдельных ветках).
Работа с ветками позволяет делать отдельные Pull Request'ы на каждое изменение. Это делает процесс разработки прямым и позволяет избежать головной боли при разработке.

* Нажмите ПКМ по папке с билдом. Выберите '''TortoiseGit''', затем '''Switch/Checkout'''
* В Branch выберите ветку, от которой желаете сделать ответвление.
* Для работы с чистой версией билда Paradise выберите "remotes/upstream/master220"
* Отметьте галочкой "Create New Branch".
* Назовите ветку удобным названием.
* Нажмите '''OK''', новая ветка будет создана, а билд автоматически переключится на неё.

====Перемещение между ветками (Switch Branches)====
* Нажмите ПКМ по папке с билдом. Нажмите '''TortoiseGit''', затем '''Switch/Checkout...'''
* Выберите нужную ветку, нажмите '''OK'''

===Создание коммита===
* A commit is confirmed change of the files in your repo, it's how you make changes permanently to the files in your repo, so try not to commit without making sure it works (though subsequent commits can fix it).
* As said before, you should use different branches to separate your commits/changes. Don't commit to master. It should be clean, so you can fall back on it if needed.
* To make your commits, you need to edit the files using BYOND's inbuilt editing tools. Make sure to follow coding standards when making your changes! When you're finished, right click the folder you're working with and choose '''Git Commit -> "[Your Branch Name]"''' (Example: Git Commit -> "My_First_Branch")
* You can then select only the files you want to be committed by ticking or unticking them. You should also write a detailed commit summary, detailing what happened in that commit.
* Click '''Ok''' and the commit will be committed to your local repo!

===Создание Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по разработке

2023-10-28T03:47:54Z

Vladisvell: Исправление опечатки

Это руководство предназначено для обучения новичков успешной работе с кодом билда '''Paradise.'''

Пожалуйста, прочитайте руководство полностью от верха до низа.

'''Чтобы максимально удобно и эффективно вносить изменения в код вам будут нужны эти три вещи:'''
# Текстовый редактор (VSCode крайне рекомендован)
# Github
# Сам BYOND редактор — Dream Maker

{{toc_right}}

== Быстрая навигация ==
<span style="font-size:1.4em;">[[#Я абсолютный новичок|Я абсолютный новичок]]</span> <br>
[[#Малые изменения|Я хочу внести малые изменения или/и я спрайтер]] <br>

=== Рабочее пространство ===
* [[#Устанавливаем и настраиваем Visual Studio Code|Мне нужно установить\настроить VS Code]]
* [[#Установка и настройка Github|Мне нужно настроить Git/Github]]
* [[#Настройка и использование Github Desktop|Я хочу использовать Github Desktop (Дружелюбно к новичкам)]]
* [[#Setting up & Using TortoiseGit|Я хочу использовать TortoiseGit (Не для новичков)]]
* [[#Forking ParaCode|Я загрузил всё вышеперечисленное, как мне получить и настроить репозиторий?]]

=== Внесение изменений ===
* [[#Делаем изменения|Ок, у меня есть конфигурация репозитория, как мне менять содержимое?(Pull Requests)]]
* [[#Учимся кодить|Ок, я завершил настройку своих изменений! Как мне закодировать/внести вклад на сервер?]]
* [[#Делаем Pull Request (ПР)|Как мне создать Pull Request и отправить свои изменения через Desktop GitHub?]]
* [[#Как делать предложения правок на GutHub|Я заметил ошибку, как о ней сообщить?]]

=== Работа с редакторами ===
* [[Руководство по маппингу|У меня образование архитектора космических станций и я хочу внести изменения в карту]]
* [[Руководство по спрайтингу|Я свободный художник-академик и хочу поработать со спрайтами]]

=== Дополнительно ===
* [[#Учимся использовать TGUI|Как использовать TGUI для создания красивых интерфейсов?]]
* [[Как делать перевод игры]]?
* [[Запуск локального сервера|Как запустить локалку через Dream Daemon?]]
* [[Запуск локального сервера#Запуск по кодерски|Как запустить локалку через VSC?]]

=== Для продвинутых ===
* [[Настройка базы данных|Настройка БД на локалке]]
* [[Структура кода SS13]]
* [[Форматирование текста]]
* [[SS13 для опытных программистов]]
----
Вы также можете помочь с переводом гайдов и их дополнением для будущих потомков: [[Руководство по редактированию вики]]

==Я абсолютный новичок==
Итак, вы в ситуации, с которой сталкивался каждый разработчик Paradise. Как мне научиться работать и привносить свой вклад? Как мне добавить свой код к коду сервера? Что ж, тут несколько шагов, как начать работу и загрузить ресурсы.

Просто прочитайте этот гайд пока не дойдёте до конца. Пока вы следуете этим шагам всё должно быть в порядке!

<center>[[File:ContributingFlowchartRU.png|800px]]</center>

==Малые изменения==
Возникают ситуации, когда вы являетесь спрайтером или человеком, которому нужно поменять всего пару значений, а кодера по таким пустякам дергать не хочется. Да и зачем накидывать на кодеров такую работу, если можно сделать самому, правильно? <br>
В этом плане вам повезло, так как это руководство и создано для новичков и тех, кто никогда не работал с кодом или трогал только конфиги в разных играх. Выше находится [[#Я абсолютный новичок|гайд для новичков]], в нём по пунктам объяснено как вам нужно вклиниваться в разработку для занесения изменений. <br>
После того как вы освоите базу для внесения изменений, вы сможете тратить буквально минуты на свои собственные идеи и быть действительно полезным. А у "более крутых кодеров" будет больше времени на крупные фичи, фиксы и рефакторы. <br>
Самостоятельность - это хорошо.

Если вкратце по пунктам описать что вам потребуется:
* [[#Устанавливаем и настраиваем Visual Studio Code|Visual Studio Code]] - для внесения изменений
* [[#Настройка и использование Github Desktop|GitHub Desktop]] - для загрузки изменений
* [[#Forking ParaCode|Репозиторий]] - ваш личный билд куда вы вносите изменения
* [[#Делаем Pull Request (ПР)|Pull Request]] - для добавления изменений в основной билд
* Дождаться правок после внесения изменений в основной билд, если они будут
* Ждать, пока изменение не зальют на основной билд.
* ...
* Profit!

При внесении малых изменений, наподобие уменьшения урона у оружия, добавления другой иконки, изменения описания/названия, обязательно убедитесь, что всё корректно работает и именно так как вы и хотели, и вы ничего лишнего не затронули.

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Как может затронуться что-то лишнее?'''</span><br>
<div class="mw-collapsible-content">
Вы можете допустить опечатку, случайно поставить пробел не в том месте. В любом случае, Github Desktop покажет вам все ваши изменения и вы сможете увидеть, где могли допустить ошибку. <br>
Но также, у предмета есть "наследование", и все его внутренние переменные передаются его детям, что может внести изменения также и другим вещам. Возьмем например два предмета (родитель и дочь) с путями <code>food/cake</code> и <code>food/cake/chocolate</code>. Нам нужно изменить им описание <code>desc</code>. У первого предмета в коде написан <code>desc</code>, когда у второго он не написан. Это означает что описание предмета <code>food/cake/chocolate</code> будет взято(наследоваться) у <code>food/cake</code>, и все изменения этого предмета будут также влиять на дочерние. Чтобы этого избежать, вам всего-лишь нужно добавить дочерним предметам недостающую переменную со значениями, если вы не хотите чтобы они тоже менялись.
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Пример: Добавление одежды для должности интерна'''</span><br>
<div class="mw-collapsible-content">
Вы дошли до внесения изменений, но еще не внесли сами изменения, так как не понимаете как? Вы хотите добавить одежду или изменить её, но запутались что именно вам нужно делать? Тогда данный пункт гайда для вас. В нём мы разберем как сделать одно из простейших изменений, а также продемонстрируется интересная фича.

Возьмём в пример одежду доктора и сделаем из неё новую одежду для интерна, на английском мы знаем что название профессии Medical Doctor. Воспользуемся поиском VSC, чтобы найти его одежду. <br>
[[File:MakeClothes1.png]]

Находим одежду <code>medical doctor's jumpsuit</code> в файле <code>medsci.dm</code>. Перейдем к самому файлу и посмотрим что в нём находится. <br>
[[File:MakeClothes2.png]]

Разберем по порядку:
* /obj/item/clothing/under/rank/medical - путь нашего объекта, который наследует всё что в нём написано, наследует методы и параметры одежды <code>/clothing/</code>, типа предмета <code>/item/</code> и типа объекта <code>/obj/</code>.
* '''name''' - название нашей одежды
* '''desc''' - описание нашей одежды метода предмета <code>/item/</code>
* '''icon_state''' - название иконки лежащей на земле или в инвентаре, которая берется из файла <code>'icons/obj/clothing/uniforms.dmi'</code>
* '''item_color''' - название нашего слоя одежды на мобе, который берется из файла <code>'icons/mob/uniform.dmi'</code>. 4 спрайта в одном файле для каждого из 4-х направлений (Север, Восток, Запад, Юг)
* '''permeability_coefficient''' - коэффициент проницаемых болезней в тело куклы. 1 - обычная величина. А 0.5 - уменьшенная проницаемость (лучше стойкость)
* '''armor''' - коэффициенты защиты одежды. В нашем случае он слегка устойчив к биозаражению (10). 100 - максимальная величина.

Теперь сделаем одежду, наследующую все переменные с нашей докторской одежды, чтобы у неё тоже были те же данные с коэффициентами проницаемости и бронёй, но при этом другая иконка и название. <br>
Создадим в коде одежду интерна: <br>
[[File:MakeClothes3.png]]

Разберем по порядку
* /obj/item/clothing/under/rank/medical'''/intern''' - создаем новый тип объекта, путем добавления <code>/intern</code> к пути изначального объекта. Благодаря этому он наследует всё что было определено в объектах по этим путям.
* '''name''' - новое название нашей одежды. Теперь это одежда интерна.
* '''icon_state''' - название иконки одежды нашего интерна добавленного в файл.
* '''item_color''' - название слоя нашей одежды на кукле, который мы добавили в файл

Теперь разберем как добавлять файлы одежды.
Для начала откроем необходимый нами файл, находящиеся по заданным путям, в данном случае мы возьмём за пример слой одежды на кукле, находящийся по пути <code>'icons/mob/uniform.dmi'</code>. <br>
[[File:MakeClothes4.png]]

После открытия файла, необходимо теперь найти одежду доктора по известному нам названию слоя <code>"medical"</code> <br>
[[File:MakeClothes5.png]]

Экспортируем (скачаем) слой одежды. <br>
[[File:MakeClothes6.png]]

Изменяем наш слой одежды через редакторы, конвертируя файл в .png или в самом Dream Maker. Но спрайтеры рекомендуют использовать Asperite

Если вы начинающий спрайтер, то не забудьте ознакомиться с [[Руководство по спрайтингу|руководством для спрайтеров]]. Он поможет вам соориентироваться в поиске файлов. <br>
Если у вас остаются вопросы, вы хотите продвинутой разработки и гайд вам в этом уже не помогает, вы всегда можете обратиться за помощью к другим начинающим разработчикам, спрайтерам и кодерам. <br>

Новая одежда интерна и её иконка: <br>
[[File:MakeClothes7.png]]

После того, как новая одежда была создана, нам необходимо её импортировать (загрузить): <br>
Это не обязательно, если одежда уже была нарисована в файле с помощью Копирования Dream Maker. <br>
Для иконки мы проделываем тоже самое в его пути. <br>
[[File:MakeClothes8.png]]

Результат импортирования: <br>
Не забудьте сохранить файл. Горячие клавиши сохранения: '''Ctrl + S'''. Если на файле присутствует знак звездочки *, это означает что файл не сохранен. <br>
[[File:MakeClothes9.png]]

Теперь необходимо проверить, нормально ли отрисовывается одежда на кукле при надевании. <br>
[[Запуск локального сервера#Запуск по кодерски|Чтобы проверить, необходимо запустить локалку.]] <br>

Если локалка правильно настроена и у вас появились "щитспавн кнопки", откройте Game Panel, где вы сможете заспавнить нужный вам объект, в нашем случае мы в спавн объектов вписываем путь нашего предмета: <code>/obj/item/clothing/under/rank/medical/intern</code>. <br>
На самом деле достаточно вписать только <code>/intern</code> и он сразу выдаст вам все похожие варианты объектов на это слово. <br>
[[File:MakeClothes10.png]]

Теперь оденем нашу куклу и проверим всё ли стабильно отрисовывается и нет ли никаких артефактов (например полупрозрачные символы, которые вы случайно могли оставить). <br>
Сравним его также с обычной одеждой доктора. <br>
[[File:MakeClothes11.png]]

Добавление одежды успешно. Слой стабильно отрисовывается и нас всё устраивает. <br>
Теперь можно переходить к пункту загрузки изменений и добавить новую одежду интерна в билд. <br>

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Интересная фича'''</span><br>
<div class="mw-collapsible-content">
Вы можете сделать одежду для альтернативных названий должностей, для этого вам предстоит зайти в файлы профессий находящиеся по пути <code>"code/game/jobs/job/"</code> <br>
В этой папке находятся файлы, которые определяют, во что будет одета та или иная должность и её должностные свойства. <br>
Возьмём всё также в пример файл медицинских должностей: <code>"code/game/jobs/job/medical.dm"</code> <br>

Находим интересующую нас должность или добавляем новую. В случае должности интерна это будет выглядеть так: <br>
[[File:MakeClothes12.png]]

У должности интерна определяется во что он будет одет: <code>outfit = /datum/outfit/job/doctor/intern</code>

Определяются альтернативные названия: <code>alt_titles = list("Student Medical Doctor", "Medical Assistant")</code>

Для каждого слота доступного игроку, определяется во что будет одета кукла при заходе на должность. <br>
Так как должность интерна наследуется от должности доктора, то он одевается сначала в него, а потом в то, что определяется по новому пути. <br>
Так, униформа от доктора у него будет отличаться и он будет одет в новую одежду для интерна: <br>
<code>uniform = /obj/item/clothing/under/rank/medical/intern</code> <br>

Для альтернативных названий, с помощью копирования данного кода с заданием пути, возможно определить, во что будет одета альтернативная должность: <br>
[[File:MakeClothes13.png]]

В данном коде указывается, что "Medical Assistant" будет одет в униформу <code>/obj/item/clothing/under/rank/medical/intern/assistant</code> <br>
А "Student Medical Doctor" будет одет в специальную светло-зеленый комплект одежды с головой <code>head</code> и униформой <code>uniform</code> <br>
</div></div>
</div></div>

</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">

==Устанавливаем и настраиваем Visual Studio Code==
=== Установка VScode===

* Идём на вебсайт VSCode's: https://code.visualstudio.com/
* Загружаем и устанавливаем актуальную версию.

=== Установка VSCode плагинов===
Когда вы откроете Paradise репозиторий, у вас появится уведомление об установке некоторых рекомендованных дополнений, они просто устанавливаются по данному алгоритму

* Перейдите на вебсайт VScode и загрузите плагины
* Нажатие "Установка" перенаправит вас в VSCode где вы можете установить и перезагрузить его

Вот пара плагинов, которые крайне полезны для кодинга в DM
* Подсветка синтаксиса: https://marketplace.visualstudio.com/items?itemName=gbasood.byond-dm-language-support
* Поиск символов: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
</div>
<br>
<div class="toccolours mw-collapsible" style="width:99%">
==Установка и настройка Github==
Эта часть про установку и настройку Git и созданию Github аккаунта.
===Установка Git Bash===
* Переходим: http://git-scm.com/downloads
* Загружаем Windows Git программу, подходящую вашей операционной системе (оно должно будет выглядеть как "Git-2.18.0-64-bit.exe")
* Устанавливаем его и оставляем всё в стандартном режиме (просто пропускаем всё кнопкой next).
* Дожидаемся конца установки.
* Готово!
===Регистрируемся в Git===
(Пропустите, если у вас уже есть аккаунт)
Вам нужен будет аккаунт, чтобы привносить изменения в репозиторий (Место, где хранится код) должным образом.
* Переходим: https://github.com/
* Нажимаем '''Sign up''' в правом верхнем углу.
* Вводим свою почту
* Придумываем пароль
* Создаём себе крутой ник
* Соглашаемся или отказываемся от рассылки.
* Решаем капчу и создаём аккаунт!
* Готово!

===Скрываем свою почту (Опционально, рекомендуется)===
Некоторые из вас не захотят показывать в своём резюме, что они работали над какими-то сомнительными проектами. Или более приближённо, сообщество SS13 мрачно и полно ужасов, и вам захочется защитить свою почту (или использовать подставную почту в первую очередь).

О, и вам наверняка захочется редактировать ERP сервера под альтернативным именем.

По умолчанию включено, но лучше перестраховаться
* Заходим в аккаунт на Github
* В правом верхнем углу нажимаем на свой профиль
* Появится список, выбираем "настройки"
* Переходим к Emails
* Включаем настройку Keep my email addresses private. Теперь Github будет использовать безответны письма при операциях.
* Теперь вы защищены лучше!

===Настраиваем Git (Опционально)===
* Переходим: https://help.github.com/articles/set-up-git/#setting-up-git
* Следуя гайду выше, вы можете установить Git для Windows если хотите, однако это не рекомендуется
* Теперь у вас есть полностью настроенный Git, но если вы неграмотны в написании кода, как я, то вам захочется иметь какую-нибудь причудливую графику!

===Дополнительные видео===
Вспомогательные видео (на английском) для лучшего понимания Github.

*[https://www.youtube.com/watch?v=ZDR433b0HJY Введение в Git с Scott Chacon от GitHub]
*[https://www.youtube.com/watch?v=MYP56QJpDr4 Git from bits up]
*[https://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds (Тот парень, которой изобрёл Linux и Git)]

==Форк кода Парадайза==

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

;Форкинг
:Создание своего ответвления от оригинального кода, создание репозитория

Теперь посетите [https://github.com/ss220-space/Paradise Paradise Github репозиторий] Вам нужно будет нажать кнопку <code>Fork</code> в правом верхнем углу.

[[File:ForkingParacode.png]]

Ого, у вас теперь есть свой репозиторий! Фактически репозиторий — полная копия оригинального кода, отличие лишь в том, что они не связаны и любые ваши изменения не влияют на оригинал. Теперь, давайте скомбинируем ваш репозиторий и VS Code! Вернитесь в VS Code и перезапустите его. Под меню контроля ресурсов (выглядит как ветка дерева) нажмите <code>Clone Repository</code>.

Это должно будет выглядеть так:

[[File:VSCodeSidebar.png]]

Если этой кнопки там нет, то вы можете нажать комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> что бы открыть список команд, затем введите туда <code>Git: Clone</code> и нажмите <kbd>Enter</kbd>.

Теперь, вставьте URL репозитория, который вы создали пару шагов назад. Для этого зайдите в свой репозиторий через меню профиля, а после возьмите ссылку страницы. Оно должно быть похоже на такую ссылку: <code><nowiki>https://github.com/ваше</nowiki> имя/имя репозитория</code> Далее выберите папку, в которой будет хранится локальный репозиторий. Процесс загрузки может занять много времени, налейте себе чаю. После загрузки откройте эту папку в VS Code. Теперь у вас есть локальная копия кода!

===Расширения VS Code===
Нажмите на кнопку <code>Extensions</code> (расширения) на левой панели (выглядит как кучка квадратов), или нажмите комбинацию <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>. Вы должны будете увидеть количество рекомендованных расширений. Если нет, пропишите <code>@recommended</code> в поисковую строку. По крайней мере вы захотите установить необходимые расширений из списка ниже. Рекомендованные расширения не обязательны, но значительно облегчат вам работу.

====Необходимые расширения====

; BYOND DM Language Support
:Подсветка синтаксиса для языка DM
; DreamMaker Language Client
:Необычные функции, такие как отладка и переход к определениям
; EditorConfig for VS Code
:Загружает стандартную конфигурацию редактора для кодовой базы
; ESlint
:Предоставляет список для Javascript (этот необходим только если вы планируете работать с TGUI)

====Рекомендованные расширения====
; GitLens
:Предоставляет классные фичи, такие как возможность выбрать строчку и увидеть время последней редакции и кто её редактировал
; Error Lens
:Подсветка строк кода, в которых есть ошибки и показывание ошибок в той же строчке
; GitHub Pull Requests
:Позволяет сделать запрос помощи прямо из редактора
; Git Graph
:Позволяет более визуально удобно работать с ветвями
; Bracket Pair Colorizer 2
:Подкрашивает скобки в разные цвета, позволяя не запутаться в их количестве

===Добавляем Paracode как верхний репозиторий===
Нам надо добавить главный Paradise репозиторий в качестве удалённого репозитория.

чтобы сделать это, откройте командную палитру, введите <code>Git: Add Remote</code> и нажмите <kbd>Enter</kbd>. Далее, вам предложит ввести URL ссылку , а потом и имя удалённого репозитория. Вводим <code>https://github.com/ss220-space/Paradise</code> в качестве URL, и <code>upstream</code> в качестве имени. После завершения вы будете иметь главный Paradise репозиторий в качестве верхнего удалённого: Это позволит вам легко отправлять запросы о помощи позже.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Делаем изменения==
Во-первых, давайте поговорим о '''ветвях'''. Первое, что надо выполнить - это сделать новую ветвь в вашем ответвлении. Это важно, потому что вам никогда не следует делать изменения в вашу обычную ветвь (оригинальную) вашего ответвления. Ей стоит оставить в чистом состоянии.
<br>
'''Для каждого PR, который вы создаёте делайте новую ветку.''' Таким образом, каждый ваш индивидуальный проект будет иметь свою собственную ветвь. Изменения одной ветки не будут влиять на другие ветки, так что вы сможете работать над несколькими проектами одновременно.
===Создание ветвей===
Чтобы создать новую ветвь, откройте source control на боковой панели. Перейдите к More Actions menu (выглядит как <code>...</code>) и нажмите <code>Checkout to...</code> , типа такого:

[[File:VSCodeBranching.png]]

Теперь нажмите "Create new branch". В этом гайде я буду создавать новую шляпу, поэтому именем моей ветки будет <code>hat-landia</code>. Если вы посмотрите в левый нижний угол, вы увидите, что VS Code автоматически проверил нашу ветку:[[File:VSCodeBranchExample.png]]
<br>
Запомните, '''никогда не изменяйте главную ветвь!''' Вы можете работать с любой веткой сколько вам угодно, пока фиксируете изменения в отдельной (новосозданной) ветке.
<br>
Вперёд! Меняйте код как хотите! Это гайд по тому, как вносить изменения, не по тому, что вам вносить! Так что я не расскажу вам как именно вам кодить, создавать спрайты или менять карту. Если вам нужна будет помощь, попробуйте спросить в канале <code>#help-chat</code> или дождитесь кого-то из кодеров в онлайне в дискорде.

===Изменения кода===
Вы можете найти код для редактирования во владке "Explorer" (два листа бумаги) в боковой панели; если вам надо найти файл или строку кода, и вы знаете его имя или расположение, то вы можете использовать поиск, он находится в боковой панели под Explorer.
<br>

<pre>Стиль старой школы: если вы хотите использовать DreamMaker вместо этого, можете редактировать их там - как только вы их сохраните, VS Code обновит ваши изменения и вы сможете продолжать следовать гайду здесь.</pre>

Теперь сохраняем свои изменения. Если вновь взглянем на контроль ресурсов (Source Control), мы увидим, что у нас появилось несколько изменений. Git нашёл каждое изменение, которое вы сделали со своим форком на вашем компьютере! Даже если вы изменили единственный пробел в одной строчке кода, Git найдёт это изменение. Просто убедитесь, что вы сохранили свои файлы.
=== Тестируем свой код ===
Самый простой способ протестить свои изменения, это нажать '''F5''' или воспользоваться меню '''run and debug''' под контролем ресурсов'''.''' Это скомпилирует ваш код, запустит сервер и присоединит вас к нему, а так же выдаст вам права администратора. Это также запустит дебаггер, который поможет вам изучить, что могло пойти не так, когда ошибка закроет вам игру. Если вы хотите не запускать дебаггер, то нажмите '''Ctrl + F5''' для запуска. Запуск сервера может занять длительное время, не надо постоянно останавливать и перезапускать запуск.

Если F5 автоматически не запускает локальный сервер, возможно, вы установили BYOND по пользовательскому пути, и VSC не нашел его. В этом случае попробуйте следующее:
# Нажмите «'''Ctrl''' + ''','''», чтобы открыть настройки VSC.
# Введите «DreamMaker», выберите «DreamMaker language client configuration».
# В ячейку «DreamMaker: Byond Path» добавьте свой путь к BYOND (например, <code>D:\Program Files (x86)\BYOND</code>).
# Нажмите OK и закройте вкладку.
# Нажмите клавишу F5, чтобы запустить сервер.

Если это не работает, вы можете скомпилировать код в dmb, запустить Dream Daemon, выбрать файл dmb, установить Security(безопасность) на Trusted(Доверенное) и нажать GO, чтобы запустить сервер. После запуска сервера вы можете нажать на новую кнопку над кнопкой GO/STOP (которые теперь красные), чтобы подключиться.

Просто запуск локального сервера не сделает вас админом в игре автоматически, для этого вам надо скопировать всё из <code>/config/example</code> и вставить это в <code>/config</code>. Затем надо будет отредактировать <code>/config/admins.txt</code> , добавив строчку <code>ваше имя в byond - Hosting Provider</code> в список, по аналогии с примером, который уже будет в файле.

[[Файл:DreamDaemon.png]]

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

===Изменения в вашу ветку===
Наведите указатель мыши на слово '''Changes''' и нажмите знак плюса, чтобы подготовить все измененные файлы. Это должно выглядеть так:

[[File:VSCodeStageChanges.png]]

Или выберите каждый файл, который вы хотите изменить по отдельности. Staged Changes — это изменения, которые вы собираетесь отправить в коммит, а затем в Pull Request. Как только вы это сделаете, они появятся на новой вкладке «Staged Changes»

[[File:VSCodeStagedChanges.png]]

Нажмите на один из файлов кода, которые вы изменили! Вы увидите всплывающее окно сравнения исходного файла с новым файлом. Здесь вы можете видеть, строка за строкой, каждое сделанное вами изменение. Красные линии — это строки, которые вы удалили или изменили, а зеленые — это строки, которые вы добавили или обновили. Вы даже можете включить или отключить отдельные строки с помощью меню More Actions <code>(...)</code> в правом верхнем углу.

Теперь, когда вы подготовили свои изменения, вы готовы сделать коммит. В верхней части панели вы увидите раздел Message «Сообщение». Введите имя, описывающее ваши изменения в коммите и описание, если необходимо. Будьте лаконичны! По вашему коммиту должно быть понятно какие изменения оно совершает.

Убедитесь, что вы проверили новую ветку, созданную ранее, и нажмите на галочку! Это сделает ваш коммит и добавит его в вашу ветку. Это должно выглядеть так:

[[File:VSCodeCommit.png]]

Ну вот! Вы успешно внесли изменения(commit) в свою ветку(branch). Он все еще «неопубликован» и находится только на вашем локальном компьютере, на что указывает значок маленького облака и стрелки в левом нижнем углу.

===Публикация на GitHub===
Щелкните значок GitHub на левой боковой панели, выглядящий как кошка в кругу. Теперь вам нужно щелкнуть знак +, который появляется в левом верхнем углу, например:

[[File:VSCodeCreatePR.png]]

Затем выберите верхний репозиторий (upstream repo) и нацельтесь на главную ветку(master branch). Вы сможете выбрать название вашего PR. Расширение сделает ваш PR с выбранным вами заголовком и описанием по умолчанию. '''ПЕРЕД ОТПРАВКОЙ:''' убедитесь, что вы правильно создали PR и следовали шаблону описания.

Примечание к журналам изменений (ChangeLogs). Журналы изменений должны быть ориентированы на игрока, то есть они должны быть понятными и применимыми к обычному пользователю, не знакомому с кодингом. Будьте как можно более проще,
<pre>Исправление(fix): Исправлена ошибка с X, когда вы Y
Фича(tweak): усилен X, чтобы наносить Y больше урона. </pre>

Избегайте написания гигантских журналов изменений и внутренних изменений кода, которые явно не влияют на игровой процесс игрока. Это все примеры того, что вы не должны добавлять:
<pre>tweak: добавлен флаг NO_DROP к элементу X.
tweak: рефакторинг ДНК, чтобы CPU лучше работал
</pre>

ShareX — очень полезный инструмент для внесения вклада, так как он позволяет создавать гифки для отображения ваших изменений. вы можете скачать его, [https://getsharex.com/ здесь]

если все пойдет хорошо, ваш PR должен выглядеть так:

[[Файл:ExamplePR.png|600px]]

Если вы хотите добавить больше изменений(коммитов) в свой PR, все, что вам нужно сделать, это просто отправить эти коммиты в ветку.

</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Учимся кодить==
Теперь, когда всё настроено, осталось сделать последний штрих. Изучить логику и код. Ну ладно, не совсем последний штрих. Не бойся, хоть это одна из сложных вещей, есть масса гайдов по Dream Maker, а также кодеры, которые вам помогут! Главное правило изучение - не просите делать всё за вас, а то вы так ничего не изучите. Всё дается не сразу и поэтому стоит набраться терпения и сил. Кодерами не рождаются, ими становятся, пересилив себя ради создания хороших вещей!

[https://wiki.ss13.ru/index.php?title=All_about_the_code Переведенный гайд] <br>
[https://secure.byond.com/docs/ref/info.html# DM Reference] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STYLE.md TG STYLE] <br>
[https://github.com/tgstation/tgstation/blob/master/.github/guides/STANDARDS.md TG STANDARDS] <br>

</div>
<div style="width:99%" class="toccolours">

<span style="font-size:1.8em;">'''СТОЯТЬ! Если ты только начинаешь и уверен что готов двигаться дальше, то можешь ознакомиться с инструкциями ниже по настройке твоих IDE и дополнительной информацией.'''</span>
</div>

<div class="toccolours mw-collapsible" style="width:99%">
==Настройка и использование Github Desktop==
* Заходим на: https://desktop.github.com/
* Скачиваем Github Desktop для своей системы.
* Дожидаемся окончания установки!
* Следуем шагам для регистрации/логина на GitHub..

===Ответвление [Fork]===
Читаем [[#Forking ParaCode|данный гайд по ответвлению.]][[Файл:CloneRepo.png|мини|Выпадающее меню]]

===Создание локального репозитория===
* Открываем Github Desktop
* Выбираем "File", "Clone repository.."
* Выбираем ваш ответвленный Paradise репозиторий
* Выбираем локальный путь куда будет клонирован репозиторий
* Нажмите Clone и дождитесь окончания
*Теперь у вас есть локальный репозиторий на вашем устройстве

===Обновление вашего репозитория===
* Перед тем как начать работу, вы должно обновить ваш master
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на ''Current Branch'' в верхней части экрана
*Выберите ваш ''master'', для нашего билда это '''master220'''
* Кликните внизу на ''Choose a branch to merge into '''master220'''''
* Найдите ''upstream/master branch'' и выберите его.
* Нажмите на ''Merge '''upstream/master''' into '''master220'''''
[[Файл:Branch.png|мини|Branch в GitHub Desktop]]

===Ответвляем от репозитория [Branch]===
*'''Branch-ветвление вашего репозитория очень важно для организации ваших коммитов (изменений), у вас должна быть отдельная ветка для каждого несвязанного изменения кода (например, если вы хотите создать несколько новых спрайтов для одного элемента и изменить свойства другого, они должны быть в отдельных ветках). Запросы на слияние (Pull Request) работают с ветками (Branch), а не с коммитами, это позволит вам создавать отдельные запросы на слияние для каждого изменения. Это упростит весь процесс и избавит всех от головной боли...'''
* Откройте Github Desktop и выберите ваш репозиторий
*Нажмите на Current Branch в верхней части экрана
*В выпадающем меню нажмите на New Branch
* Задайте ему название зависимое от ваших изменений и нажмите Create branch

===Переключение между branch-ветвями===
* Откройте Github Desktop и выберите ваш репозиторий
* Нажмите на выпадающее меню Current branch и выберите branch-ветку на который хотите переключиться.
* If you have open changes then it might fail. Either stash, commit or discard the open changes and try again. Если у вас есть изменения, это может привести к ошибке. Вы можете их зафиксировать, оставить в предыдущей ветке, отменить изменения и повторить попытку.
[[Файл:Commit Change.png|мини|Внесение изменения]]

===Делаем Commit-изменение===
* Коммит — это подтвержденное изменение файлов в вашем репозитории, именно так вы постоянно вносите изменения в файлы в вашем репозитории, поэтому старайтесь не вносить коммит, не убедившись, что он работает (хотя последующие коммиты могут это исправить).
*Как и было ранее сказано, вы должны использовать разные версии веток-branch'ей для внесения ваших commit-изменений. '''Не вносите изменение в ваш master.''' Он должен оставаться чистым, чтобы вы могли использовать его для создания последующих веток и откатов при нужде.
*Чтобы внести свои изменения-commit'ы, вам нужно отредактировать файлы с помощью встроенных инструментов редактирования BYOND или любого другого инструмента редактирования, такого как Visual Studio Code ([[Руководство по разработке#Устанавливаем и настраиваем Visual Studio Code|Как его установить?]]), который рекомендуем для разработки. Обязательно соблюдайте стандарты кодирования при внесении изменений!
* Откройте Github Desktop и выберите ваш репозиторий
* Повторно проверьте внесенные вами изменения.
* Назовите внесенные изменения.
* Опционально, опишите внесенные вами изменения.
* Нажмите ''Commit to "BRANCH_NAME"''
*Ваши изменения внеслись в вашу ветку, вы можете повторно увидеть их во вкладке History

===Делаем Pull Request (ПР)===
* Открываем Github Desktop и выбираем ваш репозиторий
* Нажимаем на Public branch
* Переходим на ваш GitHub репозиторий, к примеру: https://github.com/NAME/Paradise
* Нажимаем '''Pull Request''' на самом верху
* Заполняем форму с изменениями, после чего создает Pull Request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
*Готово! Во многих случаях в ваших изменениях могут обнаружиться ошибки, на которые указали другие участники, либо же неудачные конфликты слияния или другие вещи, которые потребуют от вас пересмотра вашего запроса на включение.
*Не забудьте убедиться что у вас всё верно и постарайтесь получить одобрение от других участников разработки.
*Теперь вам необходимо ожидать внесения ваших изменений в родительский репозиторий.
</div>

<div class="toccolours mw-collapsible" style="width:99%">

==Setting up & Using TortoiseGit==

<div class="toccolours mw-collapsible mw-collapsed" style="width:99%;">
<span style="font-size:1.2em;">'''Настройка на английском. Для новичков рекомендуем по прежнему использовать Github Desktop'''</span><br>
<div class="mw-collapsible-content">

* Go here: http://code.google.com/p/tortoisegit/wiki/Download
* Download the right TortoiseGit for your system.
* When installing, click '''OpenSSH''' rather than TortoisePLink
* Finish installing.
* '''RESTART YOUR COMPUTER THIS IS NOT A DRILL.'''

===Forking Code===
See [[#Forking ParaCode|this]]

===Downloading the Code===
* Find a place you don't mind the code sitting.
* Right click and choose '''Git Clone...'''
* The URL field should be filled with the URL of your Fork. If not, paste it in.
* Click Next and watch flying tortoises bring you your code.

===Setting up TortoiseGit===
* Right click '''on the folder that was created''' (usually called Paradise), and go to '''TortoiseGit''' and then click on '''Settings'''.
* Click on '''Remote''' under '''Git'''.
* There should be one thing on the list of remotes, with the name: '''origin'''.
* You're now adding the main repository as a source you can pull updates from.
* In the '''Remote''' box type in '''upstream'''.
* In the '''URL:''' box put: https://github.com/ss220-space/Paradise.git
* Click '''Add New/Save'''.
* Click '''Ok'''.
* Almost done!

===Updating your Repository===
* Updating your repo with the master should be done before trying anything.
* Right-click the folder your repo is in and select '''TortoiseGit''' then '''Pull'''.
* Click the radial button next to '''Remote''' and make sure '''upstream''' (or whatever you called it) is selected next to it.
* The '''remote branch''' should be set to '''master'''.
* Then click '''Ok'''. This will pull the latest changes from the master repo.

===Making a Branch===
Branching your repo is very important for organising your commits, you should have a different branch for each unrelated code change (e.g. if you wanted to make some new sprites for one item and change the properties of another these should be in seperate branches), as Pull requests work off branches rather than commits this will allow you to make a seperate Pull Request per change. Doing this streamlines the whole process and will save everyone a bunch of headaches.

* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Create Branch...'''
* Type in your new branch name
* (Optional) Tick '''Switch to new branch'''
* Press '''Okay''' and your new branch is created

====Switching between Branches====
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Switch/Checkout...'''
* Choose your Branch then press '''Okay'''

===Making a Commit===
* A commit is confirmed change of the files in your repo, it's how you make changes permanently to the files in your repo, so try not to commit without making sure it works (though subsequent commits can fix it).
* As said before, you should use different branches to separate your commits/changes. Don't commit to master. It should be clean, so you can fall back on it if needed.
* To make your commits, you need to edit the files using BYOND's inbuilt editing tools. Make sure to follow coding standards when making your changes! When you're finished, right click the folder you're working with and choose '''Git Commit -> "[Your Branch Name]"''' (Example: Git Commit -> "My_First_Branch")
* You can then select only the files you want to be committed by ticking or unticking them. You should also write a detailed commit summary, detailing what happened in that commit.
* Click '''Ok''' and the commit will be committed to your local repo!

===Making a Pull Request===
* Right-click in your working folder. Then choose '''TortoiseGit''', and '''Push...'''
* Set '''Local''' and '''Remote''' to the name of the branch you committed before. (e.g. My_First_Branch)
* Under Destination, set Remote: to '''origin'''.
* Click '''Ok'''. This'll upload your changes to your remote repo (the one on GitHub).
* Head to your GitHub repo e.g https://github.com/NAME/Paradise
* Click '''Pull Request''' at the top right.
* Fill out a summary and then create the pull request.
* You're done! In many cases there will be issues pointed out by other contributors, unfortunate merge conflicts, and other things that will require you to revisit your pull request.
* Optionally, view Clean Commits for a guide on cleaner commit logs, '''cleaner commits help maintainers review!'''

===Clean commits / Squashing commits(Optional)===
* Your commit logs are filthy, full of one or two line commits that fix an error that makes you look bad, and the commit is called "Whoops" or "oops"
* Navigate to your '''local version of the branch'''
* Ensure it is up to date with the '''remote'''
* Go to '''Show log'''
* Select all the commits associated with this change or PR
* Right click and choose '''Combine to one commit'''
* This will open up the standard commit interface for TortoiseGit, with the commit logs of the selected commits merged together
* Perform the normal routine for a commit
* Go to '''push''' your branch to the '''remote branch'''
* Ensure '''Force Overwrite Existing Branch (may discard changes)''' is selected to make sure the PR/Remote updates to contain just this squashed commit
</div>

</div></div></div>

==Как делать предложения правок на GitHub==
=== Окно изменений PR'а ===
# Статус ПРа.
## Open - открыт. ПР готов принимать правки и быть замерженым в проект.
## Merged - занесен в билд. Нет смысла предлагать правки
## Closed - закрыт по какой-либо причине. В большинстве случаев нет смысла предлагать правки, если автор не собирается открывать
## Draft - ПР в разработке. Правки нужны только если автор не против или он сам попросил
# Список измененных файлов. Можно нажать чтобы быстро переместиться
# Наведите курсор на строку и нажмите на плюсик, если хотите внести правку
# Путь к файлу, можно быстро скопировать и использоваться в вашей IDE
# Завершение занесения правок
[[Файл:Review1_small.png]]

=== Написание правки ===
Не обязательно что это будет именно правка. Возможно вы решили просто прокомментировать строку, так как знаете более лучший способ решения или у вас возник какой-то вопрос.
# Строка к которой применяется правка или комментарий
# Кнопка для внесения предложения по изменению строки
# Внесение правки в "общий пул"
# Завершение написания правок и окончание ревью
[[Файл:Review2.png]]

=== Окончание ревью ===
# Кнопка завершения ревью со всем пулом правок.
# Вердикт. Написание комментария ко всему пулу внесенных вами правок.
# Прокомментировали код. Возможно что-то стало непонятно или нашли более лучшее решение.
# С кодом все в порядке и возражений нету.
# Вы запросили изменения, надо что-то исправить.
[[Файл:Review4.png]]

=== Отображение правки ===
Если вы являетесь автором PR'а и вам внесли правки:
# Принять заносимую правку для внесения в ваш PR/Branch
# Вводная строка для комментирования правки
# Отметить что вы решили эту проблему, загрузили правку и вмешательства более не требуются (до следующих правок).
[[Файл:Review3.png]]

==Учимся использовать TGUI==
Если вы все еще новичок, рекомендуется больше узнать о DM, прежде чем переходить к TGUI. Все наши пользовательские интерфейсы (кроме элементов OOC, таких как панели администратора) сделаны с использованием TGUI или должны быть преобразованы в TGUI в какой-то момент в будущем. (Вот куда это ведет!)

TGUI использует InfernoJS (на основе reactJS), который является расширением для javascript. Учиться может быть сложно, потому что это совершенно другой язык, но не бойтесь! Есть много руководств, которым вы можете следовать.

===Guides===
TGUI прост, но его трудно понять тому, кто с ним не знаком. ПРОЧИТАЙТЕ ЭТИ РУКОВОДСТВА. И да. Они на английском.

Обязательно прочитайте их по порядку
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript A re-introduction to JavaScript]
* [https://reactjs.org/docs/hello-world.html Guide to using ReactJS] <- На самом деле мы не используем react, но полезно для изучения
* [https://infernojs.org/docs/guides/components Brief rundown of InfernoJS]
* [https://github.com/ss220-space/Paradise/blob/master/tgui/docs/tutorial-and-examples.md TGUI Tutorials and Examples]

{{Contribution Guides}}

[[Категория:Руководства]]

Руководство по еде и напиткам/Алкогольные напитки и коктейли

2023-06-01T13:43:12Z

Vladisvell: Добавлены эффекты напиткам согласно недавнему ПРу. https://github.com/ss220-space/Paradise/pull/2880

{| class="wikitable sortable" style="width:85%; text-align:left; border: 3px solid #010032; cellspacing=0; cellpadding=2; background-color:white;"
|+Рецепты и эффекты алкогольных напитков.
! scope="col" style="width:150px; background-color:#BADDFF;" |Название
! scope="col" class="unsortable" style="width:150px; background-color:#BADDFF;" |Рецепт
! scope="col" style="width:150px; background-color:#BADDFF;" |Крепость
! scope="col" class="unsortable" style="background-color:#BADDFF;" |Эффекты
|-
!style="background-color:#E3F3FF;"|Кислотный плевок<br>
[[File:AcidSpit.gif]]<br>(Acid Spit)
|
*5 Wine
*1 Sulphuric Acid
|style="text-align:center;"|'''0.3'''
|Заставляет кричать с 50% шансом при глотке.
|-
!style="background-color:#E3F3FF;"|Коктейль союзников<br>
[[File:AlliesCocktail.png]]<br>(Allies Cocktail)
|
*1 Classic Martini
*1 Vodka
|style="text-align:center;"|'''0.5'''
|Нет
|-
!style="background-color:#E3F3FF;"|Алоэ<br>
[[File:Aloe.png]]<br>(Aloe)
|
*1 Watermelon Juice
*1 Milk Cream
*1 Whiskey
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Амасек<br>
[[File:Amasec.png]]<br>(Amasec)
|
*1 Iron
*5 Wine
*5 Vodka
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Андалузия<br>
[[File:Andalusia.png]]<br>(Andalusia)
|
*1 Rum
*1 Whiskey
*1 Lemon Juice
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Антифриз<br>
[[File:antifreezeglass.png]]<br>(Anti-Freeze)
|
*2 Vodka
*1 Cream
*1 Ice
|style="text-align:center;"|'''0.2'''
|Поддерживает температуру тела при переохлаждении, нагревая тело с шагом в 20 кельвинов.
|-
!style="background-color:#E3F3FF;"|Эпплджек<br>
[[File:cognac.png]]<br>(Applejack)
|
*охладить 2 части Cider до 270 K в химическом нагревателе
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Атомная бомба<br>
[[File:Atomicbombglass.gif]]<br>(Atomic Bomb)
|
*10 B-52
*1 Uranium
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|B-52<br>
[[File:B-52.png]]
|
*1 Irish Cream
*1 Kahlua
*1 Cognac
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Бахама Мама<br>
[[File:Bahamamamaglass.png]]<br>(Bahama Mama)
|
*2 Rum
*2 Orange Juice
*1 Lime Juice
*1 Ice
|style="text-align:center;"|'''0.2'''
|Несмотря на отсутствие бананов, [[Клоун|клоунов]] не лечит. '''HONK'''
|-
!style="background-color:#E3F3FF;"|Благословение Бахуса<br>
[[File:Bacchus-blessing.gif]]<br>(Bacchus' Blessing)
|
*1 Hooch
*1 Absinthe
*1 Manly Dorf
*1 Syndicate Bomb
|style="text-align:center;"|'''3'''
|'''Вас предупредили.'''
|-
!style="background-color:#E3F3FF;"|Босяк<br>
[[File:Barefoot.png]]<br>(Barefoot)
|
*1 Cream
*1 Vermouth
*1 Berry Juice
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Удар Бипски<br>
[[File:BeepskySmash.gif]]<br>(Beepsky Smash)
|
*2 Lime Juice
*2 Whiskey
*1 Iron
|style="text-align:center;"|'''0.5'''
|Постоянно вас оглушает, заставляя вас ронять все предметы из рук, пока коктейль в организме.
|-
!style="background-color:#E3F3FF;"|Пилоко<br>
[[File:Bilk.png]]<br>(Bilk)
|
*1 Beer
*1 Milk
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Чёрный русский<br>
[[File:BlackRussian.png]]<br>(Black Russian)
|
*3 Vodka
*2 Kahlua
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Кровавая Мэри<br>
[[File:BloodyMary.png]]<br>(Bloody Mary)
|
*1 Vodka
*2 Tomato Juice
*1 Lime Juice
|style="text-align:center;"|'''0.2'''
|Выводит одну единицу <font color="green">токсинов</font> из организма каждые 20 циклов метаболизации.
|-
!style="background-color:#E3F3FF;"|Козявка<br>
[[File:Boogerglass.png]]<br>(Booger)
|
*1 часть Cream
*1 Banana Juice
*1 Rum
*1 Watermelon Juice
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Храбрый бык<br>
[[File:BraveBull.png]]<br>(Brave Bull)
|
*2 Tequila
*1 Kahlua
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Укол генокрада<br>
[[File:ChangelingSting.gif]]<br>(Changeling Sting)
|
*1 Lime Juice
*1 Lemon Juice
*1 Screwdriver
|style="text-align:center;"|'''0.7'''
|Вызывает небольшую тряску экрана. Любой способ ввода кроме гипоспрея - не канон.
|-
!style="background-color:#E3F3FF;"|Классическое мартини<br>
[[File:ClassicMartini.png]]<br>(Classic Martini)
|
*2 Gin
*1 Vermouth
|style="text-align:center;"|'''0.5'''
|Взболтать, но не смешивать.
|-
!style="background-color:#E3F3FF;"|Куба либре<br>
[[File:CubaLibre.png]]<br>(Cuba Libre)
|
*2 Rum
*2 Cola
*1 Lime Juice
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Кровь демона<br>
[[File:Demonsbloodglass.gif]]<br>(Demons Blood)
|
*1 Space Mountain Wind
*1 часть Rum
*1 часть Blood
*1 часть Dr. Gibb
|style="text-align:center;"|'''0.4'''
|Вызывает ощутимую тряску экрана
|-
!style="background-color:#E3F3FF;"|Поцелуй дьявола<br>
[[File:DevilsKiss.png]]<br>(Devil's Kiss)
|
*1 Blood
*1 Rum
*1 Kahlua
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Самое сухое мартини<br>
[[File:Driest Martini.png]]<br>(Driest Martini)
|
*1 Nothing
*1 Gin
|style="text-align:center;"|'''0.5'''
|Вызывает тряску экрана. Насыщает на 1 за юнит. С 55 по 110 цикл у вас становится запутанная речь.
|-
!style="background-color:#E3F3FF;"|Пьяный идиот<br>
[[File:Drunkenblumpkin.png]]<br>(Drunken Blumpkin)
|
*1 Blumpkin Juice
*1 Ice
*2 Irish Cream
|style="text-align:center;"|'''0.5'''
|Напиток для напивающихся.
|-
!style="background-color:#E3F3FF;"|Эгг-Ног<br>
[[File:Eggnog.png]]<br>(Eggnog)
|
*5 Cream
*5 Egg
*5 Rum
|style="text-align:center;"|'''0.1'''
|Насыщает организм на 2 за юнит.
|-
!style="background-color:#E3F3FF;"|Сюрприз Эрики<br>
[[File:ErikaSurprise.png]]<br>(Erika Surprise)
|
*1 Ale
*1 Lime Juice
*1 Whiskey
*1 Ice
*1 Banana Juice
|style="text-align:center;"|'''0.2'''
|Со вкусом разочарования.
|-
!style="background-color:#E3F3FF;"|Горящий Мо<br>
[[File:Flamingmoe.gif]]<br>(Flaming Moe)
|
*1 Cognac
*1 Gin
*1 Saline-Glucose Solution
*1 Tequila
*1 Vodka
Температура 374K
|style="text-align:center;"|'''0.5'''
|Нет
|-
!style="background-color:#E3F3FF;"|Джин-физ<br>
[[file:GinFizz.png]]<br>(Gin Fizz)
|
*2 Gin
*1 Soda Water
*1 Lime Juice
|style="text-align:center;"|'''0.4'''
|Вызывает легкую тряску экрана.
|-
!style="background-color:#E3F3FF;"|Джин и соник<br>
[[File:GinSonic.gif]]<br>(Gin and Sonic)
|
*1 Gin and Tonic
*1 Methamphetamine
|style="text-align:center;"|
|
*С 25% шансом бодрит, убирая большое количество рассеянности, тряски экрана и сна.
*С 8% шансом генерирует в кровь 1-2 единицы метамфетамина, крича фразу типичного Соника.
*С 50% шансом кричит в чат фразы типичного Соника.
|-
!style="background-color:#E3F3FF;"|Джин и тоник<br>
[[File:GinTonic.png]]<br>(Gin and Tonic)
|
*2 Gin
*1 Tonic
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Гольдшлягер<br>
[[File:Goldschlagerglass.png]]<br>(Goldschlager)
|
*10 Vodka
*1 Gold
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Грог<br>
[[File:Grog.png]]<br>(Grog)
|
*1 Water
*1 Rum
|style="text-align:center;"|'''0.2'''
|Распитие напитка одобрено корпорацией NanoTrasen
|-
!style="background-color:#E3F3FF;"|Радость Хиппи<br>
[[File:HippiesDelight.png]]<br>(Hippie's Delight)
|
*1 часть Psilocybin
*1 часть Gargle Blaster
|style="text-align:center;"|
|
*У вас появляется наркотический экран. С 1 цикла по 5 у вас нарушена речь и появляется нервный тик.
*С 5 по 10 цикл у вас увеличивается нервный тик и трясет экран.
*Начиная с 10 цикла тряска и тик начинают мешать нормальной игре.
Метаболизм - 0.2
|-
!style="background-color:#E3F3FF;"|Бухло<br>
[[File:Hoochglass.png]]<br>(Hooch)
|
*2 Ethanol
*1 Welding Fuel
*1 Universal Enzyme
|style="text-align:center;"|'''1'''
|Вызывает тряску экрана. Лечит [[Ассистент|ассистентов]] на 1 урон от <font color="orange">ожогов</font> и <font color="red">травм</font>.
|-
!style="background-color:#E3F3FF;"|Пиво со льдом<br>
[[File:IcedBeer.png]]<br>(Iced Beer)
|
*10 Beer + 1 Frost Oil
''ИЛИ''
*5 Beer + 1 Ice
|style="text-align:center;"|'''0.2'''
|Регулирует температуру горячих тел с шагом в 20 кельвинов.
|-
!style="background-color:#E3F3FF;"|Ирландская автомобильная бомба<br>
[[File:Irish Car Bomb.png]]<br>(Irish Car Bomb)
|
*1 Irish Cream
*1 часть Ale
|style="text-align:center;"|'''0.3'''
|Вызывает легкую тряску экрана.
|-
!style="background-color:#E3F3FF;"|Ирландское кофе<br>
[[File:IrishCoffee.png]]<br>(Irish Coffee)
|
*2 Irish Cream
*2 Coffee
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Ирландские сливки<br>
[[File:IrishCream.png]]<br>(Irish Cream)
|
*2 Whiskey
*1 Cream
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Джек Роуз<br>
[[File:Patronglass.png]]<br>(Jackrose)
|
*4 Applejack
*1 Lemon Juice
|style="text-align:center;"|'''0.4'''
|Таков на вкус стиль.
|-
!style="background-color:#E3F3FF;"|Лонг-Айленд айс ти<br>
[[File:LongIslandIcedTea.png]]<br>(Long Island Iced Tea)
|
*1 Vodka
*1 Gin
*1 Cuba Libre
*1 Tequila
|style="text-align:center;"|'''0.5'''
|Обязательно говорите "айс ти", а не "чай со льдом", иначе вас примут за быдло.
|-
!style="background-color:#E3F3FF;"|Манхэттен<br>
[[File:Manhattan.png]]<br>(Manhattan)
|
*2 Whiskey
*1 Vermouth
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Проект "Манхэттен"<br>
[[File:Manhattanprojglass.gif]]<br>(Manhattan Project)
|
*10 Manhattan
*1 Uranium
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Маргарита<br>
[[File:Margarita.png]]<br>(Margarita)
|
*2 Tequila
*1 Lime Juice
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Медовуха<br>
[[File:Mead.png]]<br>(Mead)
|
*1 Sugar
*1 Water
*5 Universal enzume как катализатор
|style="text-align:center;"|'''0.2'''
|Медленно насыщает на 1 за юнит.
|-
!style="background-color:#E3F3FF;"|Мохито<br>
[[File:Mojito.png]]<br>(Mojito)
|
*1 Rum
*1 Lime Juice
*1 Sugar
*1 Soda Water
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Самогон<br>
[[File:clearglass.png]]<br>(Moonshine)
|
*10 Nutriment
*5 Universal Enzyme
|style="text-align:center;"|'''0.8'''
|Нет
|-
!style="background-color:#E3F3FF;"|Нейротоксин<br>
[[File:Neurotoxin.png]]<br>(Neuro-toxin)
|
*1 Ether
*1 Gargle Blaster
|style="text-align:center;"|'''0.7'''
|
*С 13 цикла роняет вас на пол до тех пор, пока не выведется напиток.
*С 55 цикла добавляет продолжительные галлюцинации.
*с 200 цикла наносит 2 урона <font color="green">токсинами</font> в цикл.
|-
!style="background-color:#E3F3FF;"|Пан-Галактический взрыв в горле<br>
[[File:GargleBlaster.gif]]<br>(Pan-Galactic Gargle Blaster)
|
*1 Gin
*1 Vodka
*1 Whiskey
*1 Cognac
*1 Lime Juice
|style="text-align:center;"|'''0.7'''
|Нет
|-
!style="background-color:#E3F3FF;"|Радужное небо<br>
[[File:Радужное небо.gif|64px]]<br>(Rainbow sky)
|
*1 Doctor's delight
*1 Banana Honk
*1 Erica Surprise
*1 Screwdriver
*1 Pan-Galactic Gargle Blaster
|style="text-align:center;"|'''1.5'''
|Все цвета радуги и немного даже космоса.
*Вызывает наркотический экран, сильные галлюцинации, несвязную речь и сильную тряску экрана.
*Исцеляет 1 урон от <font color="red">травм</font> и <font color="orange">ожогов</font> в цикл.
|-
!style="background-color:#E3F3FF;"|Patron<br>
[[File:Patronglass.png]]<br>(Patron)
|
*10 Tequila
*1 Silver
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Красная медовуха<br>
[[File:RedMead.png]]<br>(Red Mead)
|
*1 Mead
*1 Blood
|style="text-align:center;"|'''0.2'''
|Напиток настоящих викингов.
|-
!style="background-color:#E3F3FF;"|Сбитень<br>
[[File:Sbiten.png]]<br>(Sbiten)
|
*1 Vodka
*1 Capsaicin
|style="text-align:center;"|'''0.4'''
|Экстремально быстро возвращает в норму холодные тела с шагом в 50 кельвинов.
|-
!style="background-color:#E3F3FF;"|Отвёртка<br>
[[File:Screwdriver.png]]<br>(Screwdriver)
|
*2 Vodka
*1 Orange Juice
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Сингуло<br>
[[File:singuloglass.gif]]<br>(Singulo)
|
*5 Vodka
*1 Radium
*5 Wine
|style="text-align:center;"|'''0.7'''
|Вызывает сильную тряску экрана
|-
!style="background-color:#E3F3FF;"|Снежно белый<br>
[[File:SnowWhite.png]]<br>(Snow White)
|
*1 Beer
*1 Lemon Lime
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Суисидр<br>
[[File:suicider.png]]<br>(Suicider)
|
*1 Cider
*1 Vodka
*1 Welding Fuel
*1 Epinephrine
|style="text-align:center;"|'''1'''
|Значительно трясет экран. Выпивая этот напиток, вы достигаете дна. Со вкусом наступающей смерти.
|-
!style="background-color:#E3F3FF;"|Бомба синдиката<br>
[[File:SyndicateBomb.png]]<br>(Syndicate Bomb)
|
*1 Whiskey Cola
*1 Beer
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Текила санрайз<br>
[[File:TequillaSunrise.png]]<br>(Tequilla Sunrise)
|
*2 Tequila
*1 Orange Juice
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Мужественный дворф<br>
[[File:ManlyDorf.png]]<br>(The Manly Dorf)
|
*1 Beer
*2 Ale
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Холодный чай острова Три Мили<br>
[[File:threemileislandglass.png]]<br>(Three Mile Island Iced Tea)
|
*10 "Long Island Iced Tea"
*1 Uranium
|style="text-align:center;"|'''0.2'''
|Нет
|-
!style="background-color:#E3F3FF;"|Особый из токсикологии<br>
[[File:ToxinsSpecial.gif]]<br>(Toxins Special)
|
*2 Rum
*1 Vermouth
*2 Plasma
|style="text-align:center;"|'''0.5'''
|Регулирует температуру слишком холодного тела с шагом в 15 кельвинов.
|-
!style="background-color:#E3F3FF;"|Водка мартини<br>
[[File:VodkaMartini.png]]<br>(Vodka Martini)
|
*2 Vodka
*1 Vermouth
|style="text-align:center;"|'''0.4'''
|Нет
|-
!style="background-color:#E3F3FF;"|Водка и тоник<br>
[[file:VodkaTonic.png]]<br>(Vodka and Tonic)
|
*2 Vodka
*1 Tonic
|style="text-align:center;"|'''0.3'''
|Вызывает легкую тряску экрана
|-
!style="background-color:#E3F3FF;"|Виски кола<br>
[[File:Wiskey_cola.png]]<br>(Whiskey Cola)
|
*2 Whiskey
*1 Cola
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Виски сода<br>
[[File:WhiskeySoda.png]]<br>(Whiskey Soda)
|
*2 Whiskey
*1 Soda Water
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Белый русский<br>
[[File:WhiteRussian.png]]<br>(White Russian)
|
*3 Black Russian
*2 Cream
|style="text-align:center;"|'''0.3'''
|Нет
|-
!style="background-color:#E3F3FF;"|Мун'лин<br>
[[File:Moonlindrink.png|64x64px]]<br>(Moonlin)
|
*Перемолоть сухой Moonlight в All-In-One Grinder.
|style="text-align:center;"|'''N/A'''
|Обезболивающий, слегка расслабляющий напиток, после некоторого времени вызывает сонливый эффект, при передозировке наносит урон <font color="green">токсинами</font> 2-4 единиц за тик. Большой шанс зависимости. Имеет интересный эффект для расы [[таяран]].
|-
!style="background-color:#E3F3FF;"|Мун'дрин<br>
[[File:Moondrin.png|64x64px]]<br>(Moon'drin)
|
*Сварить три [[Руководство_по_гидропонике#Особые_вещества|Moonlight]] в [[Руководство_по_еде_и_напиткам#Рецепты_бутылочницы|бутылочнице]].
|style="text-align:center;"|'''0.5'''
|Двойной дистиллированный Мун'лин. Мягкий мятный вкус, который любят все таяры. Используется в коктейлях. Очень маленький шанс зависимости.
|-
!style="background-color:#E3F3FF;"|Илукский синий Мун'дрин<br>
[[File:Bluemoondrin.png|64x64px]]<br>(Iluk Blue Moon'drin)
|
*3 Moon'drin
*{{tooltip|1 Blue Lagoon (?)|(2 Blue Curacao, 2 Vodka, 1 Soda Water, 1 Ice)}}
*2 Martini
*1 Ice
|style="text-align:center;"|'''0.7'''
|Мягкий мятный вкус голубой Илукской подставы. Не подкладывайте напиток капитану! Маленький шанс зависимости.
|-
!style="background-color:#E3F3FF;"|Красноводный Мун'дрин<br>
[[File:Redmoondrin.png|64x64px]]<br>(Redwater Moon'drin)
|
*3 Moon'drin
*1 Devil's Kiss
*2 Manhattan
*1 Watermelon Juice
*1 Ice
|style="text-align:center;"|'''0.9'''
|Незаконный на Адомае таярский напиток. Опасен, и признан домом Хадии сильнейшим наркотиком на основе мун'дрина с "секретным" ингредиентом. Будьте осторожны с ним! Умеренный шанс зависимости.
|-
!style="background-color:#E3F3FF;"|Шампанское<br>
[[File:champagneglass.png|64x64px]]<br>(Champagne)
|
* 1 Champagne
|style="text-align:center;"|'''0.2'''
| Нет
|-
!style="background-color:#E3F3FF;"|Апероль<br>
[[File:aperolglass.png|64x64px]]<br>(Aperol)
|
* 1 Aperol
|style="text-align:center;"|'''0.2'''
| Нет
|-
!style="background-color:#E3F3FF;"|Джагермейстер<br>
[[File:jagermeisterglass.png|64x64px]]<br>(Jagermeister)
|
* 1 Jagermeister
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Шнапс<br>
[[File:schnapsglass.png|64x64px]]<br>(Schnaps)
|
* 1 Schnaps
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Самбука<br>
[[File:sambukaglass.png|64x64px]]<br>(Sambuka)
|
* 1 Sambuka
|style="text-align:center;"|'''0.45'''
| Нет
|-
!style="background-color:#E3F3FF;"|Голубой Кюрасао<br>
[[File:bluecuracaoglass.png|64x64px]]<br>(Blue Curacao)
|
* 1 Bluecuracao
|style="text-align:center;"|'''0.35'''
| Нет
|-
!style="background-color:#E3F3FF;"|Горький<br>
[[File:bitterglass.png|64x64px]]<br>(Bitter)
|
* 1 Bitter
|style="text-align:center;"|'''0.45'''
| Нет
|-
!style="background-color:#E3F3FF;"|Шеридан<br>
[[File:sheridanglass.png|64x64px]]<br>(Sheridan's)
|
* 1 Sheridan
|style="text-align:center;"|'''0.35'''
| Нет
|-
!style="background-color:#E3F3FF;"|Чёрная кровь<br>
[[File:black_blood.png|64x64px]]<br>(Black Blood)
|
* 2 Bluecuracao
* 1 Jagermeister
* 1 Soda water
* 1 Ice
|style="text-align:center;"|'''0.45'''
| Заставляет при глотке с шансом в 50% прокричать случайное заклинание Культа Крови.
|-
!style="background-color:#E3F3FF;"|Лёгкий Шторм<br>
[[File:light_storm.png|64x64px]]<br>(Light Storm)
|
* 2 Sheridan
* 1 Vodka
* 1 Sambuka
* 1 Cream
|style="text-align:center;"|'''0.6'''
| Нет
|-
!style="background-color:#E3F3FF;"|Кремовый рай<br>
[[File:cream_heaven.png|64x64px]]<br>(Cream Heaven)
|
* 2 Sheridan
* 2 Milk
* 1 Gin
* 1 Ice
|style="text-align:center;"|'''0.25'''
| Нет
|-
!style="background-color:#E3F3FF;"|Негрони<br>
[[File:negroni.png|64x64px]]<br>(Negroni)
|
* 2 Martini
* 1 Bitter
* 2 Orange juice
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Хиросима<br>
[[File:hirosima.png|64x64px]]<br>(Hirosima)
|
* 1 Grape juice
* 2 Sambuka
* 1 Absinthe
* 1 Irish cream
|style="text-align:center;"|'''0.3'''
| Нет
|-
!style="background-color:#E3F3FF;"|Нагасаки<br>
[[File:nagasaki.gif|64x64px]]<br>(Nagasaki)
|
* 10 Hirosima
* 1 Uranium
|style="text-align:center;"|'''0.7'''
| Нет
|-
!style="background-color:#E3F3FF;"|Шоколад Шеридана<br>
[[File:chocolate_sheridan.png|64x64px]]<br>(Chocolate Sheridan's)
|
* 5 Sheridan
* 1 Chocolate
|style="text-align:center;"|'''0.7'''
| Нет
|-
!style="background-color:#E3F3FF;"|Панама<br>
[[File:panamian.png|64x64px]]<br>(Panama)
|
* 1 Gintonic
* 2 Bluecuracao
* 1 Vodka
* 1 Ice
|style="text-align:center;"|'''0.6'''
| Нет
|-
!style="background-color:#E3F3FF;"|Клуб Пегу<br>
[[File:pegu_club.png|64x64px]]<br>(Pegu Club)
|
* 2 Gin
* 1 Orange juice
* 1 Lime juice
* 2 Bitter
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Алкомендер<br>
[[File:alcomender.png|64x64px]]<br>(Alcomender)
|
* 1 [[Руководство_по_фармакологии#Silver_Sulfadiazine|Сульфадиазин серебра]]
* 1 Ethanol
|style="text-align:center;"|'''1.4'''
| Лечит ожоги
|-
!style="background-color:#E3F3FF;"|Звездная Амнезия<br>
[[File:amnesia.png|64x64px]]<br>(Star Amnesia)
|
* 1 Hooch
* 1 Vodka
|style="text-align:center;"|'''1.2'''
| Нет
|-
!style="background-color:#E3F3FF;"|Серебряная рука<br>
[[File:johnny.png|64x64px]]<br>(Silverhand)
|
* 2 Tequila
* 1 Bitter
* 1 Beer
* 1 Berry juice
|style="text-align:center;"|'''0.6'''
| Нет
|-
!style="background-color:#E3F3FF;"|Космополитен<br>
[[File:cosmospoliten.png|64x64px]]<br>(Cosmospoliten)
|
* 2 Screwdriver cocktail
* 1 Orange juice
* 1 Lime juice
* 1 Berry juice
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Старая мода<br>
[[File:oldfashion.png|64x64px]]<br>(Old Fashion)
|
* 5 Whiskey
* 2 Bitter
* 2 Sugar
* 1 Orange juice
|style="text-align:center;"|'''0.6'''
| Нет
|-
!style="background-color:#E3F3FF;"|Французский 75<br>
[[File:french_75.png|64x64px]]<br>(French 75)
|
* 2 Gin
* 1 Lemon juice
* 2 Champagne
* 1 Sugar
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Молоко +<br>
[[File:milk_plus.png|64x64px]]<br>(Milk +)
|
* 2 Absinthe
* 2 Irish cream
* 5 Milk
* 1 Sugar
|style="text-align:center;"|'''0.8'''
| Нет
|-
!style="background-color:#E3F3FF;"|Бог Силы<br>
[[File:Teslasingylo.gif|64x64px]]<br>(God Of Power)
|
* 2 Teslium
* 2 Radium
* 1 Whiskey
|style="text-align:center;"|'''0.7'''
| Содержит невиданную силу. Заряжает КПБ.
|-
!style="background-color:#E3F3FF;"|Свет<br>
[[File:light.png|64x64px]]<br>(Light)
|
* 2 Orange juice
* 1 Mead<br>{{T|374}}
|style="text-align:center;"|'''0.2'''
| Дает слабое ночное зрение, не работает с солнцезащитными очками.
|-
!style="background-color:#E3F3FF;"|Пчелиные колени<br>
[[File:bees_knees.png|64x64px]]<br>(Bee's Knees)
|
* 2 Gin
* 1 Lemon juice
* 1 Lime juice
* 1 Honey или 3 Mead
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Авиация<br>
[[File:aviation.png|64x64px]]<br>(Aviation)
|
* 2 Gin
* 1 Berry juice
* 1 Lemon lime
* 1 Cream
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Физз<br>
[[File:fizz.png|64x64px]]<br>(Fizz)
|
* 4 Whiskey soda
* 1 Lemon juice
* 2 Sugar
|style="text-align:center;"|'''0.3'''
| Нет
|-
!style="background-color:#E3F3FF;"|Brandy Crusta<br>
[[File:brandy_crusta.png|64x64px]]<br>(Brandy Crusta)
|
* 2 Whiskey
* 1 Berry juice
* 1 Lemon juice
* 1 Bitter
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Апероль Спритц<br>
[[File:aperolspritz.png|64x64px]]<br>(Aperol Spritz)
|
* 4 Aperol
* 3 Wine
* 1 Soda water
* 2 Orange juice
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Коляска<br>
[[File:sidecar.png|64x64px]]<br>(Sidecar)
|
* 3 Cognac
* 2 Triple citrus
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Дайкири<br>
[[File:daiquiri.png|64x64px]]<br>(Daiquiri)
|
* 3 Rum
* 2 Lime juice
* 1 Sugar
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Смокинг<br>
[[File:tuxedo.png|64x64px]]<br>(Tuxedo)
|
* 2 Martini
* 2 Vermouth
* 1 Absinthe
* 1 Bitter
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Телеголь<br>
[[File:Telegol.gif|64x64px]]<br>(Telegol)
|
* 2 Teslium
* 2 Vodka
* 1 Dr. Gibb
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Лошадиная Шея<br>
[[File:horse_neck.png|64x64px]]<br>(Horse Neck)
|
* 2 Whiskey
* 3 Ale
* 1 Bitter
|style="text-align:center;"|'''0.5'''
| Заставляет ржать с 50% шансом при глотке.
|-
!style="background-color:#E3F3FF;"|Кубинский Закат<br>
[[File:cuban_sunset.png|64x64px]]<br>(Cuban Sunset)
|
* 3 Rum
* 2 Lemonade
* 1 Bitter
|style="text-align:center;"|'''0.6'''
| Нет
|-
!style="background-color:#E3F3FF;"|Бомба Саке<br>
[[File:sake_bomb.png|64x64px]]<br>(Sake Bomb)
|
* 2 Beer
* 2 Sake
|style="text-align:center;"|'''0.3'''
| Нет
|-
!style="background-color:#E3F3FF;"|Голубые Гавайи<br>
[[File:blue_havai.png|64x64px]]<br>(Blue Havai)
|
* 2 Rum
* 2 Vodka
* 1 Bluecuracao
|style="text-align:center;"|'''0.2'''
| Нет
|-
!style="background-color:#E3F3FF;"|Ву-Ву<br>
[[File:Woo_woo.gif|64x64px]]<br>(Woo Woo)
|
* 2 Vodka
* 2 Schnaps
* 1 Berry juice
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Глинтвейн<br>
[[File:mulled_wine.png|64x64px]]<br>(Mulled Wine)
|
* 2 Wine
* 2 Lemon juice<br>{{T|374}}
|style="text-align:center;"|'''0.2'''
| Нет
|-
!style="background-color:#E3F3FF;"|Белый медведь<br>
[[File:white_bear.png|64x64px]]<br>(White Bear)
|
* 2 Schnaps
* 1 Bream
* 2 Beer
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Вампиро<br>
[[File:vampiro.png|64x64px]]<br>(Vampiro)
|
* 2 Tequila
* 1 Tomato juice
* 1 Berry juice
|style="text-align:center;"|'''0.45'''
| Заставляет вспыхивать глаза выпившего, если в организме больше 20 юнитов напитка.
|-
!style="background-color:#E3F3FF;"|Королева Мария<br>
[[File:queen_Mary.png|64x64px]]<br>(Queen Mary)
|
* 2 Beer
* 2 Berry juice
* 1 Bitter
|style="text-align:center;"|'''0.35'''
| Нет
|-
!style="background-color:#E3F3FF;"|Коробка<br>
[[File:inabox.png|64x64px]]<br>(Box)
|
* 2 Gin
* 1 Potato
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Пиво королевской ягоды<br>
[[File:beer_berry_royal.png|64x64px]]<br>(Beer Berry Royal)
|
* 2 Beer
* 2 Berry juice
* 1 Grape juice
|style="text-align:center;"|'''0.25'''
| Нет
|-
!style="background-color:#E3F3FF;"|Сазерак<br>
[[File:sazerac.png|64x64px]]<br>(Sazerac)
|
* 1 Absinthe
* 1 Cognac
* 1 Bitter
* 1 Whiskey
* 2 Water
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Монако<br>
[[File:monako.png|64x64px]]<br>(Monako)
|
* 1 Gin
* 1 Lemon juice
* 1 Lime juice
* 1 Berry juice
* 1 [[Руководство_по_фармакологии#Salt|Sodiumchloride]]
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Слаймовый напиток<br>
[[File:slime_drink.png|64x64px]]<br>(Slime Drink)
|
* 5 Cherry jelly
* 2 Ice
* 1 Sugar
* 2 Gin
|style="text-align:center;"|'''0.2'''
| Нет
|-
!style="background-color:#E3F3FF;"|Невинное ERP<br>
[[File:innocent_erp.png|64x64px]]<br>(Innocent ERP)
|
* 3 Sambuka
* 1 Triple citrus
* 1 Irish cream
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Мерзкая Слякоть<br>
[[File:nasty_slush.png|64x64px]]<br>(Nasty Slush)
|
* 2 Absinthe
* 2 Kahlua
* 1 Irish cream
|style="text-align:center;"|'''0.55'''
| Нет
|-
!style="background-color:#E3F3FF;"|Голубая лагуна<br>
[[File:blue_lagoon.png|64x64px]]<br>(Blue Lagoon)
|
* 2 Bluecuracao
* 2 Vodka
* 1 Soda water
* 1 Ice
|style="text-align:center;"|'''0.5'''
| Нет
|-
!style="background-color:#E3F3FF;"|Зеленая фея<br>
[[File:green_fairy.png|64x64px]]<br>(Green Fairy)
|
* 1 Tequila
* 1 Absinthe
* 1 Vodka
* 1 Bluecuracao
* 1 Lemon juice
|style="text-align:center;"|'''0.6'''
| Вызывает наркотический экран.
|-
!style="background-color:#E3F3FF;"|Дом Лебовски<br>
[[File:home_lebovsky.png|64x64px]]<br>(Home Lebowski)
|
* 2 Vodka
* 1 Coffee
* 1 Sugar
* 1 Ice
|style="text-align:center;"|'''0.35'''
| Нет
|-
!style="background-color:#E3F3FF;"|Лучший счет<br>
[[File:top_billing.png|64x64px]]<br>(Top Billing)
|
* 2 Vodka
* 1 Bluecuracao
* 2 Lemon juice
* 1 Ice
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Транс-Сибирский Экспресс<br>
[[File:trans_siberian_express.png|64x64px]]<br>(Trans-Siberian Express)
|
* 3 Vodka
* 2 Lime juice
* 2 Carrot juice
* 1 Ice
|style="text-align:center;"|'''0.5'''
| Заставляет выпившего понимать Нео-Русский язык, а также говорить на нём, пока напиток находится в организме.
|-
!style="background-color:#E3F3FF;"|Солнце<br>
[[File:sun.png|64x64px]]<br>(Sun)
|
* 2 Rum
* 2 Berry juice
* 1 Egg
|style="text-align:center;"|'''0.4'''
| Нет
|-
!style="background-color:#E3F3FF;"|Тик-Ток<br>
[[File:tick_tack.png|64x64px]]<br>(Tick-Tock)
|
* 1 Sambuka
* 1 Watermelon juice
|style="text-align:center;"|'''0.3'''
| Нет
|-
!style="background-color:#E3F3FF;"|Урагановый выстрел<br>
[[File:uragan_shot.png|64x64px]]<br>(Uragan Shot)
|
* 1 Whiskey
* 1 Gin
* 1 Watermelon juice
|style="text-align:center;"|'''0.35'''
| Нет
|-
!style="background-color:#E3F3FF;"|Нью-Йоркер<br>
[[File:new_yorker.png|64x64px]]<br>(New Yorker)
|
* 3 Whiskey
* 1 Bitter
* 2 Grape juice
* 1 Lime juice
|style="text-align:center;"|'''0.4'''
| Нет
|-
|}