Simple Updater

简单的更新程序是创建的库，旨在帮助您在几行代码（用于游戏启动器或其他项目）中构建更新程序。
该库构建在C＃ （.NET≥4.6）和Java （JRI≥1.8_80）中。
只需下载库，将其引用到您的项目，您就可以了！
检查文档波纹管以开始使用它！ （每个langage的来源中都提供了一个示例项目）

特征：

• 在C＃和Java中开发
• 没有额外的图书馆！一切都是本地的。
• 容易集成
• 保持客户端使用服务器更新
• 删除与服务器不匹配的旧文件或不需要的文件
• 忽略列表
• WebClient配置
• 可以缓存服务器结果x分钟/秒（可选 - 如果禁用了很多文件，可以很长的响应）
• 每个步骤的触发事件（检查文件，下载，...）
• 状态代码
• 下载进程
• 异步下载
• 示例项目完全评论

欢迎任何贡献！
当前版本： 1.1

目录

• 推介会
• 目录
• 安装
  • Web服务器
  • 客户集成
    • C＃
    • 爪哇
• 代码文档
  • 创建简单的更新程序对象
  • 功能：从服务器检查文件并删除过时的文件
  • 功能：下载文件
  • simpleupdater对象的属性
  • 事件
  • 状态代码
• 示例项目
• 信用
• 执照

安装

Web服务器

您将需要一个Web服务器来托管更新程序将下载的文件。

1. 克隆/下载项目
2. 将“ php-服务器文件”中的文件上传到您的Web服务器
3. 检查index.php是否配置
4. 与index.php文件相同的目录中创建一个名为“文件”的文件夹
5. 将要下载的所有文件放在“文件”文件夹中

客户集成

C＃

1. 转到发布页面并下载简单的更新程序库。
2. 在您的项目（Microsoft教程）中引用它
3. 使用对象SimpleUpdater （请参阅文档bellow）

爪哇

1. 转到发布页面并下载简单的更新程序库。
2. 将其添加到您的项目中（教程）
3. 使用对象SimpleUpdater （请参阅文档bellow）

代码文档

创建简单的更新程序对象。

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

参数	类型	描述
server_url	string / String	将下载文件的服务器的URL
installation_path	string / String	将下载文件的路径（如果未正确设置，请小心它可以删除错误的文件）

功能：从服务器检查文件并删除过时的文件（保持更新）

 updater . CheckFilesFromServerAndDeleteOutdated ( ) ;

描述：此功能将联系服务器以获取所有文件并搜索所有本地文件和目录，哪些文件需要删除，下载或忽略。需要删除的文件将被自动删除。

下载文件之前必须调用此功能。

功能：下载文件

 updater . DownloadFiles ( ) ;

描述：这将下载所有需要下载的文件，以创建SimpleUpDater对象提供的installation_path _path。

simpleupdater对象的属性

名称（C＃）	功能（Java）	类型	描述
server_url	getServerUrl()	string / String	将下载文件的服务器的URL
installation_path	getInstallationPath()	string / String	将下载文件的路径
承重	CanDownload()	bool / Boolean	检查您是否可以开始下载文件
cancheck	CanCheck()	bool / Boolean	检查您是否可以启动本地文件的验证过程
数字bytestodownload	getNumberOfBytesToDownlaod()	long	获取将下载的字节数
状态代码	getStatusCode()	int	获取状态代码

事件

姓名	args	描述
OnCheckFined	int nbrLocalFiles int nbrServerFiles int nbrFilesToDownload int nbrFilesDeleted long numberOfBytesToDownload	验证过程结束时触发事件
ondownloadfined	long TotalBytesDownloaded	下载结束时触发的事件
OnDownloadProgresschanged	long TotalBytesDownloaded float percent	每次下载进度更改时，事件都会触发
Onstatuschanged	int code	当更新器的状态更改时，事件触发

在Java版本中，您需要创建一个类并实现SimpleUpdaterEvents类。创建此类的实例，并使用updater.addListener(yourEventClassObject)将其添加到SimpleUpdater对象的侦听器中。
检查Java示例项目以获取更多信息。

状态代码

代码	描述
0	等待行动
1	联系服务器以解析
2	搜索并删除本地文件
3	检查完成 在检查后触发（...）
4	下载开始
5	文件已成功下载
6	下载文件时发生了错误
7	发生错误将尝试访问服务器
8	下载完成 下载后触发（...）触发

示例项目

C＃

示例项目已完全评论。您可以在C＃ - 示例项目简单更新程序中找到它。

爪哇

该示例项目如果完全评论。它打印到控制台的调试。您可以在“ Java-简单的更新程序库”中找到它。

信用

• EN0- Flavien Darche

执照

MIT License