QSimpleUpdater: Introduction

| QSimpleUpdater A simple auto-updater system for Qt applications

- Main Page
- Classes
- Files

Introduction

QSimpleUpdater is an implementation of an auto-updating system to be used with Qt projects. It allows you to easily check for updates, download them and install them. Additionally, the QSimpleUpdater allows you to check for updates for different "modules" of your application. Check the WTFs for more information.

## Integrating QSimpleUpdater with your projects

1. Copy the QSimpleUpdater folder in your "3rd-party" folder.
2. Include the QSimpleUpdater project include (pri) file using the include() function.
3. That's all! Check the tutorial project as a reference for your project.

## WTFs Section

### 1. How does the QSimpleUpdater check for updates?

The QSimpleUpdater downloads an update definition file stored in JSON format. This file specifies the latest version, the download links and changelogs for each platform (you can also register your own platform easily if needed).

After downloading this file, the library analyzes the local version and the remote version. If the remote version is greater than the local version, then the library infers that there is an update available and notifies the user.

### 2. Can I customize the update notifications shown to the user?

Yes! You can "toggle" which notifications to show using the library's functions or re-implement by yourself the notifications by "reacting" to the signals emitted by the QSimpleUpdater.

1 QString url = "https://MyBadassApplication.com/updates.json";
2
3 QSimpleUpdater::getInstance()->setNotifyOnUpdate (url, true);
4 QSimpleUpdater::getInstance()->setNotifyOnFinish (url, false);
5
6 QSimpleUpdater::getInstance()->checkForUpdates (url);

### 3. Is the application able to download the updates directly?

Yes. If there is an update available, the library will prompt the user if he/she wants to download the update. You can enable or disable the integrated downloader with the following code:

1 QString url = "https://MyBadassApplication.com/updates.json";
2 QSimpleUpdater::getInstance()->setDownloaderEnabled (url, true);

### 4. Why do I need to specify an URL for each function of the library?

The QSimpleUpdater allows you to use different updater instances, which can be accessed with the URL of the update definitions. While it is not obligatory to use multiple updater instances, this can be useful for applications that make use of plugins or different modules.

Say that you are developing a game, in this case, you could use the following code:

1 // Update the game textures
2 QString textures_url = "https://MyBadassGame.com/textures.json"
3 QSimpleUpdater::getInstance()->setModuleName (textures_url, "textures");
4 QSimpleUpdater::getInstance()->setModuleVersion (textures_url, "0.4");
5 QSimpleUpdater::getInstance()->checkForUpdates (textures_url);
6
7 // Update the game sounds
8 QString sounds_url = "https://MyBadassGame.com/sounds.json"
9 QSimpleUpdater::getInstance()->setModuleName (sounds_url, "sounds");
10 QSimpleUpdater::getInstance()->setModuleVersion (sounds_url, "0.6");
11 QSimpleUpdater::getInstance()->checkForUpdates (sounds_url);
12
13 // Update the client (name & versions are already stored in qApp)
14 QString client_url = "https://MyBadassGame.com/client.json"
15 QSimpleUpdater::getInstance()->checkForUpdates (client_url);

## License

QSimpleUpdater is free and open-source software, it is released under the Don't Be A Dick License.