https://github.com/e-n-0/simple-updater
Simple Updater is a library created in C# and JAVA to help you building an Updater in few lines of code (for your game launcher or other project).
https://github.com/e-n-0/simple-updater
csharp documentation features-extraction framework game java jre8 launcher net php server simple updater webserver wiki
Last synced: about 2 months ago
JSON representation
Simple Updater is a library created in C# and JAVA to help you building an Updater in few lines of code (for your game launcher or other project).
- Host: GitHub
- URL: https://github.com/e-n-0/simple-updater
- Owner: e-n-0
- License: mit
- Created: 2018-12-10T13:59:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-06-05T15:09:56.000Z (almost 5 years ago)
- Last Synced: 2025-06-02T15:48:21.800Z (12 months ago)
- Topics: csharp, documentation, features-extraction, framework, game, java, jre8, launcher, net, php, server, simple, updater, webserver, wiki
- Language: C#
- Homepage:
- Size: 9.12 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
 [](#code-documentation)
**Simple Updater** is a library created to help you building an Updater in a few lines of code (for your game launcher or other projects).
This library is built in **C#** *(.NET ≥ 4.6)* and **JAVA** *(JRE ≥ 1.8_80)*.
Just download the library, reference it to your project and you are good to go !
Check the documention bellow to start using it ! *(An example project is provided in the source for each langage)*
### Features:
* Developped both in C# and JAVA
* No extra libraries ! All is native.
* Easy integration
* Keep the client updated with the server
* Delete old or unwanted files that doesn't match with the server
* Ignore list
* Webclient configuration
* Can cache the server result for **x** minutes/seconds *(Optional - can have a long time response if disabled with a lot of files)*
* Trigger event for each step (Checking files, downloading, ...)
* Status code
* Download progression
* Asynchronous download
* Example projects fully commented
***Any contribution is welcome !***
Current Version: **1.1**
## **Table of Contents**
* Presentation
* [Table of contents](#table-of-contents)
* [Installation](#installation)
* [Web server](#web-server)
* [Client integration](#client-integration)
* C#
* JAVA
* [Code documentation](#code-documentation)
* [Create the Simple Updater object](#create-the-simple-updater-object.)
* [Function: Check files from the server and delete outdated files](#function-check-files-from-the-server-and-delete-outdated-files-keep-updated)
* [Function: Download files](#function-download-files)
* [Attributes of SimpleUpdater object](#attributes-of-simpleupdater-object)
* [Events](#events)
* [Status code](#status-code)
* [Example Project](#example-project)
* [Credit](#credit)
* [License](#license)
## Installation
### Web Server
You will need a webserver to host files that the updater will download.
1. Clone/Download the project
2. Upload files that are in **'PHP - Server files'** to your webserver
3. Check the **index.php** for configuration
4. Create a folder named **'files'** in the same directory as the **index.php** file
5. Place all files that you want to download in that **'files'** folder
### Client integration
#### C#
1. Go to the [release](https://github.com/e-n-0/Simple-Updater/releases) page and download the **Simple Updater** library.
2. Reference it in your project ([Microsoft tutorial](https://msdn.microsoft.com/en-us/library/7314433t(VS.71).aspx))
3. Use the Object **SimpleUpdater** *(see the documentation bellow)*
#### JAVA
1. Go to the [release](https://github.com/e-n-0/Simple-Updater/releases) page and download the **Simple Updater** library.
2. Add it in your project ([A tutorial](http://www.oxfordmathcenter.com/drupal7/node/44))
3. Use the Object **SimpleUpdater** *(see the documentation bellow)*
## Code documentation
### Create the Simple Updater object.
```csharp
// We will keep 'updater' on all the documentation
SimpleUpdater updater = new SimpleUpdater(server_url, installation_path);
```
|Params |Type |Description|
|----------------|------------|-----------|
|server_url |`string` / `String` | The url of the server on which files will be download
| installation_path | `string` / `String` | The path where files will be downloaded **(be careful if not set correctly it can delete wrong files)**
### Function: Check files from the server and delete outdated files (keep updated)
```csharp
updater.CheckFilesFromServerAndDeleteOutdated();
```
**Description:**
This function will contact the server to get all files and search through all local files and directories which files need to be deleted, downloaded or ignored.
Files that needs to be deleted will be automaticaly deleted.
> This function must be called before downloading files.
### Function: Download files
```csharp
updater.DownloadFiles();
```
**Description:**
This will download all files that needs to be downloaded to the `installation_path` provided with the creation of the **SimpleUpdater** object.
### Attributes of SimpleUpdater object
|Name *(C#)* | Function *(JAVA)* |Type |Description
|------- |--------|------|-------
|Server_Url | `getServerUrl()` | `string` / `String`| The url of the server on which files will be downloaded
| Installation_path | `getInstallationPath()` | `string` / `String` | The path where files will be download
| CanDownload | `CanDownload()` | `bool` / `Boolean` | Check whether you can start the download of files
| CanCheck | `CanCheck()` | `bool` / `Boolean`| Check whether you can start the verification process of local files
| NumberOfBytesToDownload | `getNumberOfBytesToDownlaod()` | `long` | Get the number of bytes that will be downloaded
| StatusCode | `getStatusCode()` | `int` | Get the status code
### Events
|Name | Args| Description
|--------|------|---
|OnCheckFinished | `int nbrLocalFiles`
`int nbrServerFiles`
`int nbrFilesToDownload`
`int nbrFilesDeleted`
`long numberOfBytesToDownload` | Event triggered when the verification process ends
|OnDownloadFinished | `long TotalBytesDownloaded` | Event triggered when the download ends
|OnDownloadProgressChanged | `long TotalBytesDownloaded`
`float percent`| Event triggered each time the download progress changed
| OnStatusChanged | `int code` | Event triggered when the status of the updater change
> In the JAVA version you need to create a class and implement the `SimpleUpdaterEvents` class to it. Create an instance of this class and add it to listeners of `SimpleUpdater` Object with `updater.addListener(yourEventClassObject)`.
Check the JAVA example project for more information.
### Status code
| Code | Description
|-|-
| 0 | Waiting for action
| 1 | Contacting server for files to parse
| 2 | Search and delete local files
| 3 | Check finished
Triggered after Check_Finished(...)
| 4 | Download started
| 5 | A file has been successfully downloaded
| 6 | An error occurered when downloading a file
| 7 | An error occured will trying to access the server
| 8 | Download finished
Triggered after Download_Finished(...)
## Example Projects
### C#
The example project is fully commented. You can find it in **[C# - Example Project Simple Updater](https://github.com/e-n-0/Simple-Updater/tree/master/C%23%20-%20Example%20Project%20Simple%20Updater "C# - Example Project Simple Updater")**.
### JAVA
This example project if fully commented. It prints debug to the console. You can find it in [**'JAVA - Simple Updater Library'**](https://github.com/e-n-0/Simple-Updater/tree/master/JAVA%20-%20Simple%20Updater%20Library).
## Credit
* en0 - Flavien Darche
## License
[`MIT License`](https://github.com/e-n-0/Simple-Updater/blob/master/LICENSE)