Simple Updater

Simple Updater est une bibliothèque créée pour vous aider à créer un Updater en quelques lignes de code (pour votre lanceur de jeux ou d'autres projets).
Cette bibliothèque est construite en C # (.NET ≥ 4,6) et Java (JRE ≥ 1,8_80) .
Il suffit de télécharger la bibliothèque, de le référer à votre projet et vous êtes prêt à partir!
Vérifiez la documentation ci-dessous pour commencer à l'utiliser! (Un exemple de projet est fourni dans la source pour chaque langue)

Caractéristiques:

• Développé à la fois en C # et Java
• Pas de bibliothèques supplémentaires! Tout est natif.
• Intégration facile
• Gardez le client à jour avec le serveur
• Supprimer les fichiers anciens ou indésirables qui ne correspondent pas au serveur
• Ignorer la liste
• Configuration WebClient
• Peut mettre en cache le résultat du serveur pendant x minutes / secondes (facultatif - peut avoir une réponse longue si elle est désactivée avec beaucoup de fichiers)
• Département de l'événement pour chaque étape (vérification des fichiers, téléchargement, ...)
• Code d'état
• Télécharger la progression
• Téléchargement asynchrone
• Exemples de projets entièrement commentés

Toute contribution est la bienvenue!
Version actuelle: 1.1

Table des matières

• Présentation
• Table des matières
• Installation
  • Serveur Web
  • Intégration du client
    • C #
    • JAVA
• Documentation de code
  • Créer l'objet de mise à jour simple
  • Fonction: Vérifiez les fichiers du serveur et supprimez des fichiers obsolètes
  • Fonction: téléchargez des fichiers
  • Attributs de l'objet SimpleUpDater
  • Événements
  • Code d'état
• Exemple de projet
• Crédit
• Licence

Installation

Serveur Web

Vous aurez besoin d'un serveur Web pour héberger des fichiers que le mise à jour téléchargera.

1. Clone / télécharger le projet
2. Téléchargez des fichiers qui sont dans «Fichiers PHP - serveur» sur votre serveur Web
3. Vérifiez la configuration de la configuration index.php
4. Créez un dossier nommé «fichiers» dans le même répertoire que le fichier index.php
5. Placez tous les fichiers que vous souhaitez télécharger dans ce dossier «fichiers»

Intégration du client

C #

1. Accédez à la page de version et téléchargez la bibliothèque de mises à jour simple .
2. Référencez-le dans votre projet (tutoriel Microsoft)
3. Utilisez l'objet SimpleUpDater (voir la documentation ci-dessous)

JAVA

1. Accédez à la page de version et téléchargez la bibliothèque de mises à jour simple .
2. Ajoutez-le dans votre projet (un tutoriel)
3. Utilisez l'objet SimpleUpDater (voir la documentation ci-dessous)

Documentation de code

Créez l'objet de mise à jour simple.

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

Paramètres	Taper	Description
server_url	string / String	L'URL du serveur sur quel fichiers sera téléchargé
installation_path	string / String	Le chemin d'accès où les fichiers seront téléchargés (soyez prudent s'il n'est pas réglé correctement, il peut supprimer les mauvais fichiers)

Fonction: Vérifiez les fichiers du serveur et supprimez les fichiers obsolètes (continuez à mettre à jour)

 updater . CheckFilesFromServerAndDeleteOutdated ( ) ;

Description: Cette fonction contactera le serveur pour obtenir tous les fichiers et rechercher dans tous les fichiers et répertoires locaux dont les fichiers doivent être supprimés, téléchargés ou ignorés. Les fichiers qui doivent être supprimés seront supprimés automatiquement.

Cette fonction doit être appelée avant de télécharger des fichiers.

Fonction: téléchargez des fichiers

 updater . DownloadFiles ( ) ;

Description: Cela téléchargera tous les fichiers qui doivent être téléchargés sur l' installation_path fournis avec la création de l'objet SimpleUpDater .

Attributs de l'objet SimpleUpDater

Nom (C #)	Fonction (java)	Taper	Description
Server_url	getServerUrl()	string / String	L'URL du serveur sur lequel les fichiers seront téléchargés
Installation_path	getInstallationPath()	string / String	Le chemin où les fichiers seront téléchargés
Chariot à canon	CanDownload()	bool / Boolean	Vérifiez si vous pouvez commencer le téléchargement des fichiers
Cancheck	CanCheck()	bool / Boolean	Vérifiez si vous pouvez démarrer le processus de vérification des fichiers locaux
Numéro de bytodownload	getNumberOfBytesToDownlaod()	long	Obtenez le nombre d'octets qui seront téléchargés
Code de statut	getStatusCode()	int	Obtenez le code d'état

Événements

Nom	Args	Description
Fine	int nbrLocalFiles int nbrServerFiles int nbrFilesToDownload int nbrFilesDeleted long numberOfBytesToDownload	Événement déclenché lorsque le processus de vérification se termine
Ondownloadfinished	long TotalBytesDownloaded	Événement déclenché à la fin du téléchargement
On downloadProgressChanged	long TotalBytesDownloaded float percent	Événement déclenché chaque fois que la progression du téléchargement a changé
Sur le plan	int code	Événement déclenché lorsque le statut de la mise à jour change

Dans la version Java, vous devez créer une classe et implémenter la classe SimpleUpdaterEvents . Créez une instance de cette classe et ajoutez-le aux écouteurs de l'objet SimpleUpdater avec updater.addListener(yourEventClassObject) .
Vérifiez l'exemple Java pour plus d'informations.

Code d'état

Code	Description
0	En attente d'action
1	Contacter le serveur pour les fichiers à analyser
2	Rechercher et supprimer les fichiers locaux
3	Vérifier terminé Déclenché après Check_finished (...)
4	Télécharger démarré
5	Un fichier a été téléchargé avec succès
6	Une erreur s'est produite lors du téléchargement d'un fichier
7	Une erreur se produira à essayer d'accéder au serveur
8	Télécharger terminé Déclenché après téléchargement_finished (...)

Exemples de projets

C #

L'exemple de projet est entièrement commenté. Vous pouvez le trouver dans C # - Exemple de projet Simple Updater .

JAVA

Cet exemple de projet s'il est entièrement commenté. Il imprime le débogage de la console. Vous pouvez le trouver dans «Java - Simple Updater Library» .

Crédit

• EN0 - Flavien Darche

Licence

MIT License