Updates

---

This documentation is for pre-release software and is subject to change.

---

BattleBattle uses several methods to track updates for both the client and games.

versions.xml

This file is stored within the GitHub repo and contains the latest versions of the client and all games. An example can be found below:

<?xml version="1.0" encoding="UTF-8"?>
<versions>
	<battlebattle>
		<string name="version_code">1</string>
		<string name="version_readable">1.0</string>
		<string name="update_text">BattleBattle 1.0 is here.</string>
		<string name="update_url">http://github.com/JPII/BattleBattle</string>

		<string name="announcement_code">-1</string>
		<string name="announcement_title">Welcome to BattleBattle</string>
		<string name="announcement_text">Thanks for playing! Leave feedback here: https://github.com/JPII/BattleBattle/issues</string>
		<string name="announcement_url">http://github.com/JPII/BattleBattle</string>
	</battlebattle>

	<games>
		<game>
			<string name="game_name">Test Game</string>
			<string name="game_id">2</string>
			<string name="version_code">1</string>
			<string name="version_readable">1.0</string>
			<string name="description">This is a test.</string>
			<string name="download_url">https://somewhere.com/builds/test-game-1.0.jar</string>
			<string name="hidden">0</string>
		</game>
	</games>
</versions>

BattleBattle

• version_code - internal code to track version differences (set in Constants class)
• version_readable - version number to display to the user (major.minor.build)
• update_text - version changelog and other information (keep it short)
• update_url - URL that the user should visit to view more information (should not point to a file)
• announcement_code - internal code to track announcements (stored in local settings file)
• announcement_title - title of announcement
• announcement_text - announcement text (keep it short)
• announcement_url - URL that the user should visit to view more information

Games

• game_name - name of game to display to user
• game_id - internal code to track each game
• version_code - internal code to track version differences
• version_readable - version number to display to the user (major.minor.build)
• description - version changelog and other information (keep it short)
• download_url - location of software to be downloaded
• hidden - prevents users from seeing game in client (0 is visible, 1 is hidden)

manifest.ini

Manifest files are found within each game's directory and track an installed game's data. A generic example can be found below:

game_name:Test Game
game_id:1
version_code:1
version_readable:1.0
description:This is a test game.
download_url:https://somewhere.com/builds/test-game-1.0.jar

• game_name - name of game to display to user
• game_id - internal code to track each game
• version_code - internal code to track version differences
• version_readable - version number to display to the user (major.minor.build)
• description - version changelog and other information (keep it short)
• download_url - location of software to be downloaded

Note that it is possible to edit the manifest file, leading to unforeseen consequences.