MC AutoUpdate - 0.1.0.0 release [Wednesday 15/03/2006]

One suite to code them all. An complete IDE and assembler for all your z80 projects!

Moderators: benryves, kv83

Locked
User avatar
kv83
Maxcoderz Staff
Posts: 2735
Joined: Wed 15 Dec, 2004 7:26 pm
Location: The Hague, Netherlands
Contact:

MC AutoUpdate - 0.1.0.0 release [Wednesday 15/03/2006]

Post by kv83 »

MC AutoUpdate will enable you to update all supported applications through internet. The tool will read a .xml file on a specified server, check whether you have the newest version or not and than update the application. No more manually update your apps, like EarlyMorning.

Download: MC AutoUpdate 0.1.0.0

Note: There are currently no apps which you can update with this tool. However, EarlyMorning aswell as LateNite will be supported by this tool in their next release
Documentation wrote:MaxCoderz AutoUpdate (MAU)

I...User Documentation
I.I Introduction
This tool will enable you to update all supported applications through internet. The tool will read a .xml file on a specified server, check whether you have the newest version or not and than update the application.

I.II Installation
Because this tool was written for updating EarlyMorning/LateNite, you should unzip all files into the root of LateNite.

The following files should be copied:
  • Data (Directory)
  • MC AutoUpdate.exe
It could be that another application (e.g.: EarlyMorning) already created a Data Directory.

Other applications will enable autoupdate if they place a .xml file in the Data directory.

I.III How to use
The tool is quite easy to use. Once you've started the application, just click the button "Check for updates". It will then check for every "enabled" application whtether there is an update or not and displays it in the display box. If he finds nothing, he will display a message that he didn't find anything.

If multiple updates are found he will show all available updates.

Once you click on "Update" he will update ALL applications. Please don't close the program before the update is done.

I.IV Security & Privacy Notice
Though the application has been tested it is still in beta and can damage your files. Please back-up all your files, before updating. In a future version, the tool will create a backup by itself.

The application will never create/delete/update files without the directory it is placed. Furthermore, it uploads no data, expect requests to download files.

II...Developer Documentation
II.I Introduction
MC AutoUpdate has the ability to update your application aswell. The only thing you have to do is to create an application .xml file in the data directory, upload your files to a server (not zipped) and create a update .xml file.

1. Create an application file (.xml)
2. Create an update file (.xml)
3. Upload files to your server

Also note that your application should be in the same or in a sub-directory as MC AutoUpdate.

(All tags in xml are case-sensitve at the moment. Sorry! :P)

II.II Application file
The application file holds information over your application. This file should be distributed with the latest version of your application to make sure that it is auto-update enabled.

The file is made in xml syntax, so it should be fairly easy to make. Here is a template you can/should use:

Code: Select all

	<?xml version="1.0" encoding="utf-8" ?>
	<app>
		<title></title>
		<version></version>
		<url></url>
	</app>

Between the <Title></Title> tags, you should place the title of your application. Between the <Version></Version> tags, you should place the current version of your application.

Between the <URL></URL> tags you should place the URL of the Update File (.xml).

Here is an example of a correct application file:

Code: Select all

<?xml version="1.0" encoding="utf-8" ?>
<app>
	<title>Example Application</title>
	<version>1.0</version>
	<url>http://www.server.com/autoupdate/update.xml</url>
</app>


II.III Update file
The update file, is the file downloaded, when MC AutoUpdate checks for an update.

This file contains specific information what files have to be updated, what files should be deleted and what directories should be created.

A high-level-view of the files would be:

Code: Select all

  -Release X
  |--File X
  |--File Y
  |--File Z
  -Release Y
  |--File X
  ...
As you can see, MC Update supports that if an user has missed an update, he still can update by updating his application twice.

The first release in the update file have to be your latest release!

Here is a template you can use:[/size]

Code: Select all

<?xml version="1.0" encoding="utf-8" ?>
<app>
	<release>
		<version></version>
		<changelog>Current version</changelog>
	</release>
	<release>
		<version></version>
		<changelog>New version</changelog>
		<file>
			...
		</file>
	</release>
</app>


Between the <Version></Version> tags, you should place the version-number of the release. The current version should have the same version number as in your application file!

Between <changelog></changelog> you may place change information. This will be visible for the user.

You can use multiple <file></file> tags in every release of course. This tags are used to upload or delete files aswell as create directories.

Between the <file></file> tags you should use:

Code: Select all

	<path></path>
	<action></action>
	<url></url>

Between the <path></path> tags you should place the path within the MC AutoUpdate rootdirectoy for the action.

Between the <action></action> tags you should place the action you want to perform.
There are three actions:
  • upload
  • update (does the same as upload)
  • delete
  • MakeDir

Note that those actions are case-sensitive.

Between the <url></url> tags you should place the url of the file you want to upload. If you don't upload a file, you don't have to use the <url></url> tags.

Here is an example of an update file:

Code: Select all

<?xml version="1.0" encoding="utf-8" ?>
<app>
	<release>
		<version>0.0.0.0</version>
		<changelog>Current version</changelog>
	</release>
	<release>
		<version>0.0.1.0</version>
		<changelog>Fixed some bugs and included docs!</changelog>
		<file>
			<path>Docs</path>
			<action>MakeDir</action>
		</file>
		<file>
			<path>Docs\Readme.txt</path>
			<action>upload</action>
			<url>http://www.sever.com/autoupdate/docs.txt</url>			
		</file>
		<file>
			<path>Application.exe</path>
			<action>update</action>
			<url>http://www.sever.com/autoupdate/app.exe</url>
		</file>
	</release>
</app>


II.IV Security Notice
Because MC AutoUpdate is still in beta and does not have any kind of error catching, you should first test your update file, before uploading it. Best thing you can do is to set up some kind of testserver and point your own applicationfile to that testserver.

Disclaimer
I. This application is used on your own risk. We are not responsible for any harm and/or damage this application may cause.

II. This software is no spyware. It will not scan your computer for data or any-thing else. The only information it "sends" is an request to the server for download certain files.

III. We are not responsible for update files of other applications.

IV. This software comes as it is. It does not give you the right of support and/or updates.

V. You may distribute this file only by internet and you have to include this readme file. You may not charge any money for this application, nor distribute this file on another medium including, but not limited by, CD's, DVD's and floppies.

VI. You may not decompile, hack or do any other attempts to change the application in any way.
Last edited by kv83 on Fri 21 Jul, 2006 8:30 am, edited 2 times in total.
Image
User avatar
kv83
Maxcoderz Staff
Posts: 2735
Joined: Wed 15 Dec, 2004 7:26 pm
Location: The Hague, Netherlands
Contact:

Post by kv83 »

First version. Have fun! :)
Image
Locked