Difference between revisions of "Thor Patcher"

From Hercules Wiki
Jump to: navigation, search
m (Added examples for notice page and patch list file.)
m
 
Line 1: Line 1:
−
{{outdated}}
+
 
 
{{infobox/software
 
{{infobox/software
 
|heading=[[Image:thor-oobe.jpg|250px]]<br>Thor Patcher out of the box with default skin and settings.
 
|heading=[[Image:thor-oobe.jpg|250px]]<br>Thor Patcher out of the box with default skin and settings.

Latest revision as of 04:45, 23 January 2014


Thor-oobe.jpg
Thor Patcher out of the box with default skin and settings.
Developer(s)Aeomin
Current version2.5.4.18 / September 18, 2009
2.6.2.66 / August 1, 2011
Operating systemWindows 2000/XP/Vista/7
Available inMultiple (6)
TypePatch Client
Licenseunknown (closed source)
Websitehttp://thor.aeomin.net/

Thor Patcher is designed with the client-side config file embed inside the patcher itself. Since it uses no extra DLLs, you may distribute 1 file to your players. This guide will not discuss how to setup a Web Server.

Contents

Features

  • Pack into single/multi grf file [0x200]
  • Automatically generate GRF if not exists
  • RGZ support
  • Customizable skin
  • Multilingual base on user's OS region setting
  • Background music
  • No extra dll, not even config file is needed when distribute [No conflict with other server]
  • Embed config file and resource data (images for background/buttons)
  • Custom Buttons [Hard limit >2 billion, soft limit non-existence as in 2.6.2.68]
  • Remote config file
  • Self update and client update [Supports multi client exe update(Up to 255)]

Files

  1. Patcher folder contents:
    • Thor.exe (Patcher's executable file)
  2. Tools folder contents:
    • ConfigEmbeder.exe (used to add your config to the patcher exe)
    • CheckSum.exe (used to generate a CRC32 sum of the patcher and client exe)
    • ThorGenerator.exe (used to make patches)
    • Sample skin files
    • sample config.ini
    • sample language.ini
  3. Web folder contents:
    • a sample notice.html
    • a sample main.ini

Setup

To set up your thor patcher, you need to go through the following steps:

  • make a skin
  • write a config.ini
  • write a language.ini (optional)
  • pack the config & skin into the patcher exe
  • write a main.ini
  • write a notice webpage
  • upload the main.ini & the notice to your webserver

Making a Skin

A Thor Patcher skin is divided into following parts:

  1. Background (This is the main part of a skin)
    • supported formats
      • jpg (no transparency)
      • bmp (the very top-left pixel is used for transparency)
      • partial transparency (.png) is not supported yet
  2. Buttons
    • System Buttons:
      • The typical buttons you see on every patcher:
      • Start  : starts the main client
      • Cancel : cancels the update process
      • Close  : closes thor patcher
    • Custom Buttons:
    see guide
  3. Custom Notice Box:
    see guide
  4. Progressbar (Shows the patching progress)
    • Supported formats when use image based progress bar
      • bmp
      • jpg (crashes on 2.6.1.66)
      • png (crashes on 2.6.1.66)
  5. Status message (Displays the patcher status)
You can change the size and the position of every element of the patcher, so there are almost no limits to what you can do - be creative. The easiest way to make a skin is to make a single photoshop file with layers for each part of the skin.

Writing the Config

Config.ini contains the following lines:

[Config:Main]

  • RootURL='http://domain.com/patch/'
    • The URL where you plan to store all data related to thor patcher.
  • RemoteConfigFile='main.ini'
    • The name of the 2nd part of the config (NOT the full path).
  • TimeOut=0
    • This option enables you to control how long the patcher will try to connect to your webhost before giving up.
    • Format: time in seconds.
    • 0 = Default value.
    • Don't change this unless you know what you are doing! Might lead to patcher not patching.
  • StatusFile='server.dat'
    • File that stores patch ID and possibly miscellaneous data in the future. Change it to fit your server.
  • DefaultGRF='YourRO.grf'
    • The main GRF that your server uses. This GRF will will be patched if you left target GRF field blank during making .thor file or patch from GRF/GPF.
  • ClientEXE='Your RO.exe'
    • The name of the executable that the patcher will launch after patching.
  • ClientParameter='-1sak1'
    • The parameter thor uses when calling your client exe. Useful when you want your players to be fully patched. leave blank when not using.
    • Advice: Change the parameter in your exe to something unique by hexing it, makes harder to bypass patching. Don't forget to change it in your config too.
  • FinishOnConnectionFailure=false
    • The user can only exit if the patch fails and the setting is set to false. If set to true, the user can continue to launch the game if the patcher is unable to connect to your webserver. Setting to true may lead to gravity errors and crashes.

[Config:Window]

  • AutoResize=true
    • The size of the patcher changes depending on the size of the background image. True or false.
  • Style='none'
    • Choose the style your window should have
    • none  : No border, window not resizable.
    • single  : Normal border, window not resizeable.
    • sizeable : Normal border, window resizeable (would not work if windows_autosize = true).
  • Width=1
    • Width of your patcher (in pixels). Would not work if Autosize = true
    • Possible values:
      • 1 to 10000
  • Height=531
    • Height of your patcher (in pixels). Would not work if Autosize = true
    • Possible values:
      • 1 to 10000
  • DragHandling=true
    • Should the user be able to move the patcher window by dragging on background? Note that when setting this to false, users would have to move window like every other GUI application, but they will unable to move when Style is set to none. True or false.
  • Background='images/bg.bmp'
    • Your background image path.
    • Relative to location of your config.ini
      • Example: c:\config.ini *> c:\images\bg.jpg
    • Supported formats:
      • JPG (no transparency)
      • BMP (very first pixel at top left is choosed as transparent color)
      • Partial Transparency (.png) is not supported at this moment
    • Will be packed into the patcher.exe
  • FadeOnDrag=true
    • Whether or not the window will create a fade effect when clicked and dragged (similar to window in RO). True or false.

[Config:BGM]

  • File=
    • File name.
  • Loop=True
    • Do you want the song to play over and over (AKA Loop)? True or false.
  • Volume=20
    • How loud the song is. 1-100 in volume.
  • Directory=
    • Where the song is located. When this field is set, patcher will randomly choose a music file in the specified directory. Note that File will be ignored in this case.

[Config:Misc]

  • Title='Your RO Patcher'
    • Text displayed on the window title (if Style is not set to 'none) and in taskbar.
  • HideProgressBarWhenFinish=false
    • Should the progress bar vanish when the patching is done? True or false.

[ProgressBar:bar1]

  • Width=1
    • Width of the progress bar.
  • Height=1
    • Height of the progress bar.
  • Left=1
    • Number of pixels to the left.
  • Top=1
    • Number of pixels away from the top.
  • BackColorStart=$009DEEEF
    • The background color of the progress bar when it is patching.
  • BackColorEnd=$00C2F1F1
    • The background color of the progress bar when it has finished patching.
  • FrontColorStart=$006ED5B0
    • Foreground color of the progress bar when patching.
  • FrontColorEnd=$0080DDCA
    • Foreground color when it is done.
  • FrontImage=
    • Foreground image name. (NOTE: Image must be placed in Tools\Images folder.)
  • BackImage=
    • Background image name. (NOTE: Image must be placed in Tools\Images folder.)
  • Hook='ProgressChange'
    • Most likely something to do with programming and shouldn't be messed with.

[Label:Status]

  • AutoResize = false
    • When set to true, this label will change its width depend on text size. True or false.
  • Width=369
    • How wide the text area is in pixels. Ignored when AutoResize is true.
  • Height=
    • How tall the text area is in pixels. Ignored when AutoResize is true.
  • Left=15
    • How far from the right the text area is in pixels.
  • Top=498
    • How far from the top the text area is in pixels.
  • Alignment='center'
    • Text alignment. Can be center, left, or right.
  • FontColor=$000000
    • Color of the text.
  • FontName =
    • If you desire a different font to be displayed, you put the name here. Users must have the font installed in order to see the font, so downloaded fonts most likely won't be seen.
  • FontSize =
    • Text size.
  • Text=
    • Text to be displayed at the bottom of the progress bar.
  • Hook='StatusChange'
    • Programming related.

[NoticeBox:Box0]

  • Width=347
    • Width of notice box.
  • Height=250
    • Height of notice box.
  • Left=21
    • How far from the left.
  • Top=217
    • How far from the top.
  • URL='http://domain.com/patch/notice.html'
    • URL to notice HTML file that will be displayed on startup, as long as the player is connected to the internet.

[Button:Start]

  • Default='images/start.png'
    • Image of the button in normal state.
  • OnHover='images/start2.png'
    • Image of the button when the user places the mouse cursor over it.
  • OnDown='images/start3.png'
    • Image of the button when the user presses the button.
  • Left=1
    • X coordinates of the button (in pixels).
    • Counted from the left of the background image.
  • Top=1
    • Y coordinates of the button (in pixels).
    • Counted from the top of the background image.

[Button:Exit]

  • Default='images/exit.png'
    • Image of the button in normal state.
  • OnHover='images/exit2.png'
    • Image of the button when the user places the mouse cursor over it.
  • OnDown='images/exit3.png'
    • Image of the button when the user presses the button.
  • Left=1
    • X coordinates of the button (in pixels).
    • Counted from the left of the background image.
  • Top=1
    • Y coordinates of the button (in pixels).
    • Counted from the top of the background image.

[Button:Cancel]

  • Default='images/exit.png'
    • Image of the button in normal state.
  • OnHover='images/exit2.png'
    • Image of the button when the user places the mouse cursor over it.
  • OnDown='images/exit3.png'
    • Image of the button when the user presses the button.
  • Left=1
    • X coordinates of the button (in pixels).
    • Counted from the left of the background image.
  • Top=1
    • Y coordinates of the button (in pixels).
    • Counted from the top of the background image.

Custom Buttons

[Button:Name]
Default='images/button1.png'
OnHover='images/button2.png'
OnDown='images/button3.png'

Left=80
Top=406
Mode=1
Action='http://example.com'

Declares a new button

  • [Button:Name]
    • Name or ID, must be unique for each and every button
  • Default='images/button1.png'
    • image of the button on normal state
  • OnHover='images/button2.png'
    • image of the button when mouse hovers it
  • OnDown='images/button3.png'
    • image of the button when the user click on it
  • Left=80
    • X coordinate of the button (in pixels)
    • Counted from the left of the background image.
  • Top=406
    • Y coordinate of the button (in pixels)
    • Counted from the left of the background image.
  • Mode=1
    • Functions of the button
      • Possible Mode values:
        • 1 : Open URL
        • 2 : Open File/Program
        • 3 : Displays a Message Box
        • 4 : Minimize window
        • 5 : Close Patcher
        • 6 : Makes this button as clone start button behavior
  • Action='http://example.com'
    • Applies on modes 1-3

Custom Notice Box

[NoticeBox:Name]
Width=347
Height=250
Left=21
Top=217
URL='http://domain.com/patch/notice.html'

Declares the notice box

  • [NoticeBox:Name]
    • Name or ID, must be unique for each and every notice boxes
  • Width=347
    • Width of notice box.
  • Height=250
    • Height of notice box.
  • Left=21
    • How far from the left.
  • Top=217
    • How far from the top.
  • URL='http://domain.com/patch/notice.html'
    • URL to notice HTML file that will be displayed on startup, as long as the player is connected to the internet.

Writing a language.ini

The langauge.ini is a fast way to switch your patcher's langauge without having to change the config file. It contains the same configuration lines as the language part of the config.ini

  • getting_info=Getting Information...
    • is displayed when the patcher connects to the webhost
  • update_patcher=Updating Patcher...
    • is displayed when the patcher updates itself
  • update_client=Updating Client...
    • is displayed when the patcher upates the client
  • repacking=Repacking resource files...
    • is displayed while the patcher repacks the grf
  • saving_res=Saving Resource...
    • is displayed when the patcher generating table
  • getting_file=Getting file %s.
    • is displayed when the patcher is downloading a file.
    • "%s" will be replaced with the filename of the file
    • if you want to use the "%" symbol in this message, write it as "%%"!
  • need_defrag=Data fragment reached %u%%, would you like to defrag now?
    • is displayed when the grf fragmentation reaches a certain level (configured in the main.ini)
    • "%u" will be replaced with a numeric value
    • if you want to use the "%" symbol in this message, write it as "%%"!
  • defraging=Defragment in process...
    • is displayed while the patcher defragments the grf
  • confirmation=Waiting Confirmation...
    • is displayed while waiting for a reply from the user
  • client_locked=Client Application is locked
    • is displayed when trying to patch a running client
  • failed_to_communicate=Failed to communicate with server
    • is displayed when the patcher can't connect to the webhost
  • failed_to_get=Failed to get %s
    • is displayed when the patcher cannot find a file on the webhost
    • "%s" will be replaced by the filename of the file
    • if you want to use the "%" symbol in this message, write it as "%%"!

Packing the Config Into the Patcher

Make sure the following files are in the same folder before proceeding:

  • config.ini
  • language.ini (optional)
  • Skin Files
  • ConfigPacker.exe

Now, we are going to pack the config into the patcher.

  • Start ConfigPacker
  • Select your copy of Thor.exe by clicking "browse"
  • Press "Combine"

Writing the main.ini

[Main]

  • allow=true
    • Allow patching or not.
  • Force_Start=false
  • policy_msg=
  • file_url=http://domain.com/patch/data/
    • the URL where you plan to save your patches in
      • supports both HTTP and FTP
        • HTTP: use the following format:
          • http://domain.com/dir/
        • FTP :
          • connecting as anonymous:
            • ftp://domain.com/dir/
          • connecting with user & pass:
            • ftp://username:[email protected]:port/dir/
            • username is required if you want to use a password
            • if you don't specify the port, the default one will be used

[Patch]

  • ClientSum=
  • PatcherSum=
    • Can be obtained from CheckSum tool.
  • ClientPath=
  • PatcherPath=
    • Filename of patch file when update patcher/client. These files should store in the place with other patch files.
  • PatchList=plist.txt
    • Patch list file.

Writing the Notice Page

The archive includes a sample notice.html, but you can use other formats like .php, .asp etc. By doing so, you also need change notice_file in config.ini.

If for example, you would like a feed exported from your "News and Announcements" sub-forum (or variations thereof), you could easily include a small snippet of php on the page to echo out a few of your latest topics. For example, the following code would be sufficient to output the latest 5 topics in your notice.php: 

<?php
$content = file_get_contents('http://mywebsite.com/forums/index.php?/rss/forums/1-announcements/');
if($content) {
	$i = 0;
	$xml = new SimpleXmlElement($content);
	$newsAmount = (int)5;
}
?>

<?php if(isset($xml) && isset($xml->channel)): ?>
	<?php foreach($xml->channel->item as $rssItem): ?>
		<?php $i++; if($i <= $newsAmount): ?>
		<div style="padding-left: 20px;">
			<span><a href="<?php echo $rssItem->link ?>"><?php echo $rssItem->title ?></a></span>
			<p>
				<?php echo $rssItem->description ?>
				<?php echo date('M j, Y', strtotime($rssItem->pubDate)) ?>
			</p>
			<br />
		</div>
		<?php endif ?>
	<?php endforeach ?>
<?php endif ?>

You will need to ensure that the forum topics you are exporting have an RSS feed being output. If not (in the case of IPB especially) you will need to login to the admin panel and create the export feed manually.

Patch List

By default, the file containing a list of your uploaded patches is called plist.txt, and is defined in the main.ini file situated on your web host. Patches should be defined in sequential number like so: 

...
15 20131106_newclient.thor
16 20131106_GM_Fix.thor
17 20131106_Wings.thor
... etc

See Also

External Links

Retrieved from "https://wiki.herc.ws/w/index.php?title=Thor_Patcher&oldid=855"