Automatic Software Updater: Difference between revisions

== Documentation ==

This section describes how to implement the use cases mentioned above.

=== Adding resources to the production client (U4) ===

It is easy to add resources such as sounds and images to an official client by creating the folder structure next to the .jar files. So far example create a folder data/sound and place new ogg files in there.

=== Creating a simple, normal build without signing (U3, U6) ===

This is the easiest variant, just use Eclipse to [[Configure_a_development_environment_(IDE)|setup a development environment]] or [[HowToBuildStendhal|ant dist]] to do a unsigned build. The unsigned build is fully workable except for the updater.

In most cases you don't need the updater: The official one is incompatible with your changes and setting up your own one is quite a bit of work that may not worth the trouble.

If you are packing the Stendhal client for a Linux distribution, consider to just include a start-menu entry to the webstart-client and the required java dependencies: <nowiki>javaws http://arianne.sf.net/jws/stendhal.jnlp</nowiki> for the general client or <nowiki>https://stendhalgame.org/account/mycharacters.html</nowiki> for a client specific to the official server. This way you comply with the distribution policies that you need to recompile the code (there is no code in the package). But the client will automatically get our updates and people will not get angry at you or us because it is out of date compared to the official server. We do put a lot of effort into supporting old clients, but there are often minor glitches.

=== Creating an automatic updater (U7) ===

* Create a file build.ant-private.properties in the stendhal root folder with three entries: keystore.alias, keystore.update-alias and keystore.password. The first two variables should be the same.