Работа с GitHub

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

Основные понятия, с которыми вы будете работать, - это репозиторий и коммит.

Репозиторий — это место, где хранятся и поддерживаются какие-либо данные. В нашем случае: файлы модификации.

Коммит — это операция, которая отправляет последние изменения исходного кода в репозиторий.

#Создание репозитория

Под созданием репозитория можно понять три вещи:

• Создание нового пустого репозитория;
• Создание нового репозитория из папки мода;
• Клонирование репозитория.

#Создание пустого репозитория

Для создания пустого репозитория зайдите в приложение GitHub Desktop, в верхнем левом углу окна откройте меню File и нажмите New Repository….

После этого в поле Name введите название своего мода (желательно вводить название папки с модом, латиницей и без спецсимволов, например ray_v_panelke или wnfh), в поле Local path введите путь к тому месту, где будет храниться ваш мод и находиться ваш локальный репозиторий (если вы хотите, чтобы в мод сразу можно было играть, то выберите путь, ведущий к папке Steam/steamapps/common/Everlasting Summer/game или Steam/steamapps/workshop/content/331470/<любое название папки>) и нажмите на кнопку Create repository.

Для того чтобы опубликовать ваш репозиторий, нажмите на кнопку Publish repository в главном окне и в окне публикации.

#Создание репозитория из папки мода

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

#Клонирование репозитория

Для клонирования репозитория в верхнем левом углу окна откройте меню File и нажмите Clone repository….

После этого выберите нужный вам репозиторий, в поле Local path введите путь к тому месту, где будет храниться ваш мод и находиться ваш локальный репозиторий (если вы хотите, чтобы в мод сразу можно было играть, то выберите путь, ведущий к папке Steam/steamapps/common/Everlasting Summer/game или Steam/steamapps/workshop/content/331470/<любое название папки>) и нажмите на кнопку Clone.

#Операции Fetch, Pull и Push

Основные типы операций над репозиторием — это Fetch, Pull и Push.

Fetch — операция получения актуальных данных о репозитории.

Эта операция доступна, если у вас нет невыгруженных данных в локальном репозитории или если GitHub Desktop не видит изменений в онлайн-репозитории.

Pull — операция "подтягивания" актуальных данных из онлайн-репозитория и скачивания их в локальный репозиторий (загрузки файлов из интернета).

Эта операция доступна, если у вас нет невыгруженных данных в локальном репозитории и GitHub Desktop видит изменения в онлайн-репозитории, не представленные в локальном репозитории.

Push — операция "проталкивания" данных из локального репозитория в онлайн-репозиторий (выгрузки файлов в интернет).

Эта операция доступна, если у вас имеются невыгруженные данные в локальном репозитории и вы создали коммит. Для этого введите его название (можете кратко описать изменения), введите описание (более длинное описание изменений, необязательно) и нажмите Commit to main.

По отдельности все эти операции доступны во вкладке Repository, а также допустимую операцию можно вызвать, нажав на соответствующую кнопку справа от выбора ветки.

#.gitignore

Если в папке локального репозитория создать файл с названием .gitignore, то в онлайн-репозиторий не будут загружаться файлы, пути к которым записаны в этом файле. К примеру:

1
2
3
4
5*.rpyc
exactFile.txt
/folder1/folder2
/folder1/exactFile.txt
/folder1/*.mp3

Файл .gitignore с таким содержимым будет игнорировать все файлы .rpyc, файл exactFile.txt, всё содержимое папки folder2 в папке folder1, файл exactFile.txt в папке folder1 и все файлы .mp3 в папке folder1.

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

#Предоставление доступа к репозиторию

Чтобы предоставить доступ к своему репозиторию другим пользователям, перейдите на страницу вашего репозитория, войдите в настройки и во вкладке Collaborators нажмите кнопку Add people.

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

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