Skip to content

Commit 5a477f3

Browse files
committed
Fix links and some formatting in patchers pages
1 parent 244b272 commit 5a477f3

File tree

5 files changed

+271
-264
lines changed

5 files changed

+271
-264
lines changed

docs/client/patchers/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
Auto-patchers are a way for players to stay up-to-date with your latest client-side files. Most of them can update data
2-
folders and [GRF's](GRF "wikilink"). Selected patchers may support other formats as well.
2+
folders and [GRF's](../grf.md). Selected patchers may support other formats as well.
33

44
Below is a list of guides to setup each patcher. To add an article to this category add following at the end of the
55
article:
6-
7-
`[[Category:Patchers]]`
8-
9-
[Category:Client_Configuration](Category:Client_Configuration "wikilink")

docs/client/patchers/kpatcher.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
# KPatcher
2+
13
**KPatcher** is a Ragnarok Online auto-patcher, written in Embarcadero C++ Builder XE2. It was originally developed in
2-
the Russian eAthena community[1](http://www.eathena.ws/board/index.php?showtopic=216716), but later released as
3-
multi-language version[2](http://www.eathena.ws/board/index.php?showtopic=247878), currently supporting Russian,
4+
the Russian eAthena community ([link](http://www.eathena.ws/board/index.php?showtopic=216716)), but later released as
5+
multi-language version ([link](http://www.eathena.ws/board/index.php?showtopic=247878)), currently supporting Russian,
46
English, Spanish, Japanese, Chinese, Portuguese and Indonesian, with further languages being planned. It consists of the
57
patcher binary itself and a tool for creating configuration. It works on Windows 2000, Windows XP and higher.
68

@@ -75,48 +77,48 @@ The patch list is a simple text file, which uses one line for each patch. Patche
7577
beginning with // are considered a comment and ignored, which can also be used for disabling patches. Following patch
7678
types exist:
7779

78-
- **PAU**
80+
- **PAU**
7981
Specifies patch for updating the patcher.
8082
PAU:CRC:patcher.upd
8183

8284
CRC is the checksum of the new patcher executable **patcher.upd**. If the CRC of the current patcher differs, update
8385
of the patcher will occur. Might appear everywhere in the patch list, but preferably at the beginning.
84-
- **GRF**
86+
- **GRF**
8587
Specifies a patch, which will be applied to a GRF archive. This type has two forms; the first applies the patch to the
8688
main archive as specified in settings, the other applies the patch to the GRF archive specified before the type.
8789
PID:GRF:2010-09-30palettefix.gpf
8890

8991
PID:adata.grf:GRF:2010-09-30palettefix.gpf
90-
- **ARCH**
92+
- **ARCH**
9193
Specifies, that the patch is a ZIP archive, which will be extracted into the folder, where the patcher resides,
9294
including the folder structure stored inside the archive.
9395
PID:ARCH:newclient.zip
94-
- **GDF**
96+
- **GDF**
9597
Specifies a file, to be removed from the main GRF archive.
9698
PID:GDF:data\clientinfo.xml
9799

98100
This type also accepts [regular expressions](http://en.wikipedia.org/wiki/Regular_expression), such as deleting all
99101
palette files (\*.pal), would be:
100102

101103
PID:GDF:^.+\.pal$
102-
- **CDF**
104+
- **CDF**
103105
Specifies a local file to be deleted from the folder, where the patcher resides.
104106
PID:CDF:dinput.dll
105107

106108
#### Example
107109

108-
`PAU:CRC:patcher.upd`
109-
`//1:GRF:pal.gpf`
110-
`2:GRF:rdata.grf`
111-
`3:ARCH:lib.zip`
112-
`//4:ARCH:data.zip`
113-
`5:GDF:data\clientinfo.xml`
114-
`6:CDF:dinput.dll`
115-
`7:name.grf:GRF:patch.grf`
110+
```
111+
PAU:CRC:patcher.upd
112+
//1:GRF:pal.gpf
113+
2:GRF:rdata.grf
114+
3:ARCH:lib.zip
115+
//4:ARCH:data.zip
116+
5:GDF:data\clientinfo.xml
117+
6:CDF:dinput.dll
118+
7:name.grf:GRF:patch.grf
119+
```
116120

117121
## External Links
118122

119123
- [Official KPatcher Topic (English)](http://www.eathena.ws/board/index.php?showtopic=247878)
120124
- [Official KPatcher Topic (Russian)](http://www.eathena.ws/board/index.php?showtopic=216716)
121-
122-
[Category:Patchers](Category:Patchers "wikilink")

docs/client/patchers/neoncube.md

Lines changed: 42 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
To use this guide you must have a basic understanding of [Hercules](Hercules "wikilink"), a [Web
2-
Server](https://en.wikipedia.org/wiki/Web_Server) and how to edit, upload and manipulate files. You also need to be versatile in
3-
making [GRF](GRF "wikilink") and [RAR](https://en.wikipedia.org/wiki/RAR_(file_format)) files.
1+
# NeonCube
2+
3+
To use this guide you must have a basic understanding of [Hercules](../../about/index.md),
4+
a [Web Server](https://en.wikipedia.org/wiki/Web_Server) and how to edit, upload and manipulate files. You also need to be versatile in
5+
making [GRF](../grf.md) and [RAR](https://en.wikipedia.org/wiki/RAR_(file_format)) files.
46

57
## Programs you need
68

@@ -40,22 +42,23 @@ There are client and server files that need to be properly setup to work togethe
4042
8. Read the examples then edit the values (all lines starting with **;** are comments and can be removed if you want).
4143

4244
Sample **neoncube.ini**
43-
44-
<tt>`[server]`
45-
`server_name = YourRO`
46-
`notice_url = yourro.com/patcher/index.html`
47-
`patch_site = yourro.com`
48-
`patch_port = 80`
49-
`patch_list = /patcher/patchlist.txt`
50-
`patch_folder = /patcher/patch/`
51-
`executable = YourRO.exe`
52-
`registration_link = http://yourro.com/cp/`
53-
`skin = skin_rag`
54-
`grf_file = yourro.grf`
55-
`Backup_GRF = 1`
56-
`startup_option = 3`
57-
`[general]`
58-
`archive_passphrase =`</tt>
45+
```ini
46+
[server]
47+
server_name = YourRO
48+
notice_url = yourro.com/patcher/index.html
49+
patch_site = yourro.com
50+
patch_port = 80
51+
patch_list = /patcher/patchlist.txt
52+
patch_folder = /patcher/patch/
53+
executable = YourRO.exe
54+
registration_link = http://yourro.com/cp/
55+
skin = skin_rag
56+
grf_file = yourro.grf
57+
Backup_GRF = 1
58+
startup_option = 3
59+
[general]
60+
archive_passphrase =
61+
```
5962

6063
NOTES:
6164

@@ -69,43 +72,47 @@ this guide.
6972

7073
#### /patcher/index.html
7174

72-
This is the News Page that the patcher will display (supports HTML, PHP, ASP, XML)
75+
This is the News Page that the patcher will display (supports HTML, PHP, ASP, XML)
7376
Create this file on the web server you defined with **notice_url**
7477

7578
#### /patcher/patch/
7679

77-
This is the folder where you will put all the patches you create.
80+
This is the folder where you will put all the patches you create.
7881
Create this folder on the web server you defined with *patch_site*'
7982

8083
#### /patcher/patchlist.txt
8184

8285
This is the file that lists your patches and tells the NeonCube patcher (client) what to download and where to patch
83-
it.
86+
it.
8487
Create this file on the web server you defined with **patch_site**
8588

8689
Format:
8790

88-
`patch#`<TAB>`destination`<TAB>`patch_name`
91+
```
92+
patch#<TAB>destination<TAB>patch_name
93+
```
8994

90-
patch#
95+
patch#
9196
start with 1, and increment for each new patch
9297

93-
destination
98+
destination
9499
GRF will patch the grf, FLD will extract to folder
95100

96-
patch_name
101+
patch_name
97102
the name of the patch (including file extension, of course)
98103

99104
Sample **patchlist.txt** (take note of the TABs. Comments are allowed)
100105

101-
`//this will extract patch1.gpf into the data folder`
102-
`1 FLD patch1.gpf`
103-
`//here, patch2.gpf will be mergegd with grf_file`
104-
`2 GRF patch2.gpf`
105-
`//You can also delete files from the data folder.`
106-
`3 FLD data\filenametodelete.xml*`
107-
`//Deleting files inside a GRF archive is still supported`
108-
`4 GRF data\i_will_delete_you.txt*`
106+
```
107+
//this will extract patch1.gpf into the data folder
108+
1 FLD patch1.gpf
109+
//here, patch2.gpf will be mergegd with grf_file
110+
2 GRF patch2.gpf
111+
//You can also delete files from the data folder.
112+
3 FLD data\filenametodelete.xml*
113+
//Deleting files inside a GRF archive is still supported
114+
4 GRF data\i_will_delete_you.txt*
115+
```
109116

110117
## Making a .GPF patch
111118

@@ -159,11 +166,9 @@ you have additional text/formatted/unformatted characters before your list actua
159166

160167
## See Also
161168

162-
- [GRF](GRF "wikilink")
169+
- [GRF](../grf.md)
163170

164171
## External Links
165172

166173
- [Official Neoncube Homepage](http://patch.neon-cube.net/)
167174
- [Official Neoncube Board Topic](http://www.eathena.ws/board/index.php?showtopic=130342)
168-
169-
[Category:Patchers](Category:Patchers "wikilink")

docs/client/patchers/thor-patcher.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
[Thor Patcher](Thor_Patcher "wikilink") is designed with the client-side config file embed *inside* the patcher itself.
2-
Since it uses no extra DLLs, you may distribute 1 file to your players. This guide will not discuss how to setup a [Web
3-
Server](https://en.wikipedia.org/wiki/Web_Server).
1+
# Thor Patcher
2+
3+
Thor Patcher is designed with the client-side config file embed *inside* the patcher itself.
4+
Since it uses no extra DLLs, you may distribute 1 file to your players. This guide will not discuss how to
5+
setup a [Web Server](https://en.wikipedia.org/wiki/Web_Server).
46

57
# Features
68

@@ -61,10 +63,10 @@ A Thor Patcher skin is divided into following parts:
6163
- Custom Buttons:
6264

6365
64-
see [guide](#Custom_Buttons "wikilink")
66+
see [guide](#custom-buttons)
6567
3. **Custom Notice Box**:
6668

67-
see [guide](#Custom_Notice_Box "wikilink")
69+
see [guide](#custom-notice-box)
6870
4. **Progressbar** (*Shows the patching progress*)
6971
- Supported formats when use image based progress bar
7072
- bmp
@@ -441,33 +443,31 @@ If for example, you would like a feed exported from your "News and Announcements
441443
could easily include a small snippet of php on the page to echo out a few of your latest topics. For example, the
442444
following code would be sufficient to output the latest 5 topics in your notice.php:
443445

446+
```html+php
444447
<?php
445-
$content = file_get_contents('http://mywebsite.com/forums/index.php?/rss/forums/1-announcements/');
446-
if($content) {
447-
$i = 0;
448-
$xml = new SimpleXmlElement($content);
449-
$newsAmount = (int)5;
450-
}
451-
?>
452-
&#10; <?php if(isset($xml) && isset($xml->channel)): ?>
453-
<?php foreach($xml->channel->item as $rssItem): ?>
454-
<?php $i++; if($i <= $newsAmount): ?>
455-
<nowiki><div style="padding-left: 20px;"></nowiki>
456-
<nowiki><span><a href="<?php echo $rssItem->link ?>"><?php echo $rssItem->title ?></a></span></nowiki>
457-
<nowiki><p></nowiki>
458-
<?php echo $rssItem->description ?>
459-
<?php echo date('M j, Y', strtotime($rssItem->pubDate)) ?>
460-
<nowiki>
461-
462-
</nowiki>
463-
464-
`   <br />`
465-
`  </div>`
466-
`  `
467-
468-
<?php endif ?>
469-
<?php endforeach ?>
448+
$content = file_get_contents('http://mywebsite.com/forums/index.php?/rss/forums/1-announcements/');
449+
if ($content) {
450+
$i = 0;
451+
$xml = new SimpleXmlElement($content);
452+
$newsAmount = (int)5;
453+
}
454+
?>
455+
456+
<?php if(isset($xml) && isset($xml->channel)): ?>
457+
<?php foreach($xml->channel->item as $rssItem): ?>
458+
<?php $i++; if($i <= $newsAmount): ?>
459+
<div style="padding-left: 20px;">
460+
<span><a href="<?php echo $rssItem->link ?>"><?php echo $rssItem->title ?></a></span>
461+
<p>
462+
<?php echo $rssItem->description ?>
463+
<?php echo date('M j, Y', strtotime($rssItem->pubDate)) ?>
464+
</p>
465+
<br />
466+
</div>
467+
<?php endif ?>
468+
<?php endforeach ?>
470469
<?php endif ?>
470+
```
471471

472472
You will need to ensure that the forum topics you are exporting have an RSS feed being output. If not (in the case of
473473
IPB especially) you will need to login to the admin panel and create the export feed manually.
@@ -477,19 +477,19 @@ IPB especially) you will need to login to the admin panel and create the export
477477
By default, the file containing a list of your uploaded patches is called plist.txt, and is defined in the main.ini file
478478
situated on your web host. Patches should be defined in sequential number like so:
479479

480-
`...`
481-
`15 20131106_newclient.thor`
482-
`16 20131106_GM_Fix.thor`
483-
`17 20131106_Wings.thor`
484-
`... etc`
480+
```
481+
...
482+
15 20131106_newclient.thor
483+
16 20131106_GM_Fix.thor
484+
17 20131106_Wings.thor
485+
... etc
486+
```
485487

486488
# See Also
487489

488-
- [GRF](GRF "wikilink")
490+
- [GRF](../grf.md)
489491

490492
## External Links
491493

492494
- [Official Thor Patcher Homepage](http://thor.aeomin.net/)
493495
- [Official Thor Patcher Thread](http://www.eathena.ws/board/index.php?showtopic=171632)
494-
495-
[Category:Patchers](Category:Patchers "wikilink")

0 commit comments

Comments
 (0)