Simple Updater

Simple Updater - это библиотека, созданная для того, чтобы помочь вам создать обновление в нескольких строках кода (для вашего запуска игры или других проектов).
Эта библиотека построена в C# (.net ≥ 4,6) и Java (JRE ≥ 1,8_80) .
Просто загрузите библиотеку, ссылайтесь на ее проект, и вы готовы к работе!
Проверьте документ, чтобы начать использовать его! (Пример проекта представлен в источнике для каждого лангей)

Функции:

• Разработал как в C#, так и в Java
• Нет дополнительных библиотек! Все родные.
• Легкая интеграция
• Держите клиента в курсе сервера
• Удалить старые или нежелательные файлы, которые не соответствуют серверу
• Игнорировать список
• Конфигурация WebClient
• Может кэшировать результат сервера для X минут/секунд (необязательно - может иметь длительный ответ, если отключен с большим количеством файлов)
• Событие триггера для каждого шага (проверка файлов, загрузка, ...)
• Код статуса
• Загрузка прогрессии
• Асинхронная загрузка
• Пример проектов полностью прокомментировано

Любой вклад приветствуется!
Текущая версия: 1.1

Оглавление

• Презентация
• Оглавление
• Установка
  • Веб -сервер
  • Интеграция клиента
    • C#
    • Ява
• Кодовая документация
  • Создать простой объект обновления
  • Функция: Проверьте файлы с сервера и удалите устаревшие файлы
  • Функция: скачать файлы
  • Атрибуты объекта SimpleUpdater
  • События
  • Код статуса
• Пример проекта
• Кредит
• Лицензия

Установка

Веб -сервер

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

1. Клон/скачать проект
2. Загрузите файлы, которые находятся в «PHP - серверные файлы» в ваш веб -сервер
3. Проверьте index.php для конфигурации
4. Создайте папку с именем «файлы» в том же каталоге, что и файл index.php
5. Поместите все файлы, которые вы хотите загрузить в эту папку «файлы»

Интеграция клиента

C#

1. Перейдите на страницу релиза и загрузите простую библиотеку обновления .
2. Ссылка на это в свой проект (Microsoft Tutorial)
3. Используйте объект SimpleUpdater (см. Документацию ниже)

Ява

1. Перейдите на страницу релиза и загрузите простую библиотеку обновления .
2. Добавьте его в свой проект (учебник)
3. Используйте объект SimpleUpdater (см. Документацию ниже)

Кодовая документация

Создайте простой объект обновления.

 // We will keep 'updater' on all the documentation
SimpleUpdater updater = new SimpleUpdater ( server_url , installation_path ) ;

Параметры	Тип	Описание
Server_url	string / String	URL -адрес сервера, на котором будут загружаться файлы
Установка_Пат	string / String	Путь, в котором будут загружены файлы (будьте осторожны, если неправильно установлено, он может удалить неправильные файлы)

Функция: Проверьте файлы с сервера и удаляйте устаревшие файлы (продолжайте обновлять)

 updater . CheckFilesFromServerAndDeleteOutdated ( ) ;

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

Эта функция должна быть вызвана перед загрузкой файлов.

Функция: скачать файлы

 updater . DownloadFiles ( ) ;

Описание: Это будет загружать все файлы, которые необходимо загрузить в installation_path , предоставленную с созданием объекта SimpleUpdater .

Атрибуты объекта SimpleUpdater

Имя (C#)	Функция (Java)	Тип	Описание
Server_url	getServerUrl()	string / String	URL -адрес сервера, на котором будут загружены файлы
Установка_Пат	getInstallationPath()	string / String	Путь, в котором будут загружены файлы
Загрузка	CanDownload()	bool / Boolean	Проверьте, можете ли вы начать загрузку файлов
Cancheck	CanCheck()	bool / Boolean	Проверьте, можете ли вы начать процесс проверки локальных файлов
NumberOfByTestOnowlload	getNumberOfBytesToDownlaod()	long	Получите количество байтов, которые будут загружены
StatusCode	getStatusCode()	int	Получить код статуса

События

Имя	Аргс	Описание
Закончился	int nbrLocalFiles int nbrServerFiles int nbrFilesToDownload int nbrFilesDeleted long numberOfBytesToDownload	Событие вызвано при завершении процесса проверки
Ondownloadfination	long TotalBytesDownloaded	Событие вызвано, когда загрузка заканчивается
OnDownloadProgressChanged	long TotalBytesDownloaded float percent	Событие запускается каждый раз, когда изменяется прогресс загрузки
Onstatuschange	int code	Событие вызвано при изменении статуса обновления

В версии Java вам нужно создать класс и реализовать к нему класс SimpleUpdaterEvents . Создайте экземпляр этого класса и добавьте его к слушателям объекта SimpleUpdater с updater.addListener(yourEventClassObject) .
Проверьте проект Java Пример для получения дополнительной информации.

Код статуса

Код	Описание
0	В ожидании действия
1	Связь с сервером для файлов для разбора
2	Поиск и удаление локальных файлов
3	Проверьте законченность Запускается после чека
4	Скачать началась
5	Файл был успешно загружен
6	Ошибка, возникающая при загрузке файла
7	Произошла ошибка, пытаясь получить доступ к серверу
8	Скачать закончен Запускается после download_finied (...)

Пример проектов

C#

Пример проекта полностью прокомментирован. Вы можете найти его в C# - Пример Project Simple Updater .

Ява

Этот пример проекта, если полностью прокомментирован. Он печатает отладку в консоли. Вы можете найти его в «Java - Simple Updater Library» .

Кредит

• en0 - flavien darche

Лицензия

MIT License