Skip to content

Commit 21c4284

Browse files
guilherme-gmguilherme-gm
committed
Fix links and a few text in pages from "Basics" section
1 parent d2324cf commit 21c4284

File tree

10 files changed

+114
-73
lines changed

10 files changed

+114
-73
lines changed

‎docs/basics/aid.md‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
1-
An **account id** uniquely identifies a player (gender Female(F) or Male (M)) or server account (gender S) not only
2-
inside the database, but also in inter-server communication and in associations of data with an account, such as
3-
[account variables](../scripting/variables.md). Account ID is also used to save the character data, and is uniqu. In-game it
4-
is mostly used as a [game id](gid). It should not be confused with [character id](cid) which
5-
identifies a character.
1+
# Account ID (AID)
2+
3+
An **account id** uniquely identifies an account, not only inside the database, but also in inter-server communication.
4+
5+
Accounts can be classified in 2 types, based on its "Gender":
6+
7+
- Player account, for accounts with gender Female (F) or Male (M)
8+
- Server account, for accounts with gender S
9+
10+
For player accounts, the "Gender" information is used to determine the initial gender selection when
11+
creating a character in-game. For old client versions, where gender selection was not possible, this was
12+
the gender of all characters in the game account.
13+
14+
Account IDs are used to associate account-wide data with an account, such as:
15+
16+
- Characters list
17+
- [account variables](../scripting/variables.md)
18+
19+
In-game it is mostly used as a [game id (GID)](./gid.md).
20+
21+
It should not be confused with [character id (CID)](./cid.md) which identifies a character.

‎docs/basics/cid.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
1-
A **character ID** uniquely identifies a character, not only inside the database, but also in inter-server communication
2-
and association of data with a character, such as [character variables](../scripting/variables.md) or
3-
[status ailments](../overview/source/status-list.md). The character ID fulfills the same role as a combination of [account ID](aid)
1+
# Character ID (CID)
2+
3+
A **character ID** uniquely identifies a character, not only inside the database, but also in inter-server communication.
4+
5+
It associates data specific to a character, such as:
6+
7+
- Character name
8+
- Character gender
9+
- [character variables](../scripting/variables.md)
10+
- [status ailments](../overview/source/status-list.md)
11+
12+
The character ID fulfills the same role as a combination of [account ID (AID)](./aid.md)
413
and character's slot ID, which means, if two character ids match their account IDs are automatically
514
the same as well.
615

716
The Character ID typically increments starting from 150000 and going up.
8-
9-
[Category:incomplete](Category:incomplete "wikilink")

‎docs/basics/gid.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
The **GID** stands for game id or game object id. It uniquely identifies each and every dynamic object
2-
([NPC](npc), [monster](mob "wikilink"), player, item, skill unit) inside the game. For the players a GID is
3-
their [account id](aid), for all other objects it is a server-generated id, that changes each time the object
1+
# Game ID (GID)
2+
3+
The **GID** stands for game id or game object id.
4+
5+
It uniquely identifies each and every dynamic object ([NPC](./npc.md), [monster](../overview/source/mob/index.md),
6+
player, item, skill unit) inside the game.
7+
8+
For the players a GID is their [account id (AID)](./aid.md), for all other objects it is a server-generated id, that changes each time the object
49
is created.
510

611
You can view the id in-game by right-clicking on a object, when your account has enabled game master menu.
7-
8-
[Category:Incomplete](Category:Incomplete "wikilink")

‎docs/basics/gm-commands.md‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,38 @@
1+
# GM Commands
2+
13
## Syntax
24

3-
- `@<command>{,\<param 1\>,\<param 2\>,...}`
4-
- `#<command>,<target>{,\<param 1\>,\<param 2\>,...}`
5+
- `@<command> {<param 1> <param 2> ...}`
6+
- `#<command> <target> {<param 1> <param 2> ...}`
57

68
## Description
79

8-
GM commands can be used to perform a wide array of tasks in-game, such as system administration, database queries,
9-
player actions, and collecting information regarding a player, party, guild, pet, and/or homunculus. For a full list of
10-
atcommands, please see [`doc/atcommands.txt`](https://github.com/HerculesWS/Hercules/blob/stable/doc/atcommands.txt)
10+
GM commands (also called atcommands because of the **@** prefix) can be used to perform a wide array of tasks in-game,
11+
such as system administration, database queries, player actions, and collecting information regarding a player, party,
12+
guild, pet, and/or homunculus. For a full list of atcommands,
13+
please see [`doc/atcommands.txt`](https://github.com/HerculesWS/Hercules/blob/stable/doc/atcommands.txt)
1114

1215
## Examples
1316

1417
### atcommands
1518

16-
@item 909 10
19+
```
20+
@item 909 10
21+
```
1722

1823
Entering this command in-game will give the invoking player a the item 909 (Jellopy) in the amount of 10.
1924

2025
### charcommands
2126

22-
#item Ind 909 10
27+
```
28+
#item Ind 909 10
29+
```
2330

2431
Entering this command in-game will give the target player, Ind, the item 909 (Jellopy) in the amount of 10.
2532

2633
## Notes
2734

28-
While it is common knowledge throughout the [Ragnarok Online](Ragnarok_Online "wikilink") community that atcommands use
35+
While it is common knowledge throughout the [Ragnarok Online](https://en.wikipedia.org/wiki/Ragnarok_Online) community that atcommands use
2936
the **@** symbol, the symbol used can be changed to any other character by adjusting **atcommand_symbol** and
3037
**charcommand_symbol** in
3138
[`conf/atcommand.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/atcommand.conf)
@@ -38,5 +45,3 @@ the **@** symbol, the symbol used can be changed to any other character by adjus
3845
| % | party chat symbol |
3946
| $ | guild chat symbol |
4047
| / | client commands symbol |
41-
42-
[Category: Basics](Category:_Basics "wikilink")

‎docs/basics/kafra.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1+
# Kafra
2+
13
![Kafra Staff Tayelin](assets/Kafra2.gif "Kafra Staff Tayelin")
24

35
**Kafra Corporation** is a group of Ragnarok Online
4-
[NPCs](NPC "wikilink"), which is generally responsible for setting save points, giving access to player's item storage,
6+
[NPCs](./npc.md), which is generally responsible for setting save points, giving access to player's item storage,
57
providing teleport services and renting merchant class carts. Later episodes introduced two further groups for the same
68
services; namely Cool Event Corporation (western continent) and Cat Hand Services (new world).
7-
8-
9-
[Category:Incomplete](Category:Incomplete "wikilink")

‎docs/basics/mvp.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1+
# MVP
2+
13
**MVP** stands for *most valuable player*, referring to the player, which contributed most to the slay-down of a boss
2-
monster, which is itself often referred to as MVP as well. Boss monsters are the strongest monsters in [Ragnarok
3-
Online](Ragnarok_Online "wikilink"), from which the MVP gets extra experience and special prizes right into their
4+
monster, which is itself often referred to as MVP as well. Boss monsters are the strongest monsters in
5+
[Ragnarok Online](https://en.wikipedia.org/wiki/Ragnarok_Online), from which the MVP gets extra experience and special prizes right into their
46
inventory for defeating, aside from normal drops.

‎docs/basics/npc.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
![[Kafra](Kafra "wikilink") NPC](assets/Kafra2.gif "Kafra NPC")
22

3-
[NPC](NPC "wikilink") stands for Non-Player (or playable)
3+
[NPC](./npc.md) stands for Non-Player (or playable)
44
Character. An NPC is any person or "living" creature in a game not controlled by a player. For example, any units in any
55
game that would give you a quest, tell you what to do, or just stand there while you speak to them is considered an NPC.
66

7-
In [Ragnarok Online](Ragnarok_Online "wikilink"), NPCs are a pretty big part of the game. The
8-
[Hercules](Hercules "wikilink") scripting language is used to create NPCs. You can find many premade NPCs on the
7+
In [Ragnarok Online](https://en.wikipedia.org/wiki/Ragnarok_Online), NPCs are a pretty big part of the game. The
8+
[Hercules](../about/index.md) scripting language is used to create NPCs. You can find many premade NPCs on the
99
[Hercules Boards](https://herc.ws/board/). Any character you speak to in Ragnarok Online not controlled by a player is
1010
an NPC. From warpers, over healers and quest guides, to item sellers. Generally, in Ragnarok Online, a monster is
1111
referred to as a [mob](../overview/source/mob/index.md), and not an NPC, however they are technically considered NPCs as well.

‎docs/basics/rid.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1+
# RID
2+
13
Most scripting commands and functions will want to request data about a character, store variables referenced to that
2-
character, send stuff to the client connected to that specific character. Whenever a script is invoked by a character,
4+
character, send stuff to the client connected to that specific character, etc. Whenever a script is invoked by a character,
35
it is passed a so-called RID - this is the account ID number of a character that caused the code to execute by clicking
4-
on it, walking into it's [OnTouch](OnTouch "wikilink") zone, or otherwise.
6+
on it, walking into it's [OnTouch](../scripting/events/ontouch.md) zone, or otherwise.
57

6-
# Usage
8+
## Usage
79

8-
When writing simple [NPCs](NPC "wikilink") only, this topic will not require much attention. However, when using
9-
[functions](Functions "wikilink"), [timers](Timers_(Scripting) "wikilink"), or clock-based script activation, one
10+
When writing simple [NPCs](./npc.md) only, this topic will not require much attention. However, when using
11+
[functions](../scripting/functions.md), [timers](../scripting/timers.md), or clock-based script activation, one
1012
requires to be aware of all cases when a script execution can be triggered without a RID attached. This will make a lot
1113
of commands and functions unusable, since they request data from a specific character, send data to a specific client,
1214
or store variables specific to a character, which are unavailable, if there's no RID, which refers to the character to
13-
work with, unless [attachrid](attachrid "wikilink") is used to explicitly attach a character to the script first.
15+
work with, unless [attachrid](../scripting/commands/attachrid.md) is used to explicitly attach a character to the script first.
1416

15-
Whenever is stated *invoking character* or *currently attached character*, it actually means *the character whose RID is
16-
currently attached to the running script*. The script function [playerattached](playerattached "wikilink") can be used
17+
Whenever is stated **invoking character** or **currently attached character**, it actually means *the character whose RID is
18+
currently attached to the running script*. The script function [playerattached](../scripting/commands/playerattached.md) can be used
1719
to check which is the currently attached player to the script (it will return 0 if the there is no player attached or
18-
the attached player no longer is logged on to the map-server). The function [detachrid](detachrid "wikilink") will
20+
the attached player no longer is logged on to the map-server). The function [detachrid](../scripting/commands//detachrid.md) will
1921
explicitly set the RID to 0, so care must be taken, that follow-up commands do not depend on a character being attached,
2022
especially access to [temporary character variables](../scripting/variables.md).

‎docs/basics/sakray.md‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
**Sakray** is what official [Ragnarok Online](Ragnarok_Online "wikilink") test servers are usually referred to. They are
1+
# Sakray
2+
3+
**Sakray** is what official [Ragnarok Online](https://en.wikipedia.org/wiki/Ragnarok_Online) test servers are usually referred to. They are
24
used to test new content and features, before they get installed on the normal servers. When the name "Sakray" is used
35
alone, it typically refers to the kRO Sakray server. Sakray servers are always accessible via a separate client, which
46
is available through a separate download.
@@ -23,20 +25,21 @@ calculation.
2325
Schedule for tests of Renewal Server:
2426

2527
-  Closed Beta Test
26-
27-
` Start Date: 2008/07/30`
28-
` Server Name: Sakray Renewal Test Server`
29-
` Participation: Accepted testers`
30-
` Test Period: 2008/07/30 ~ 2008/08/27 (4 weeks)`
31-
28+
```
29+
Start Date: 2008/07/30
30+
Server Name: Sakray Renewal Test Server
31+
Participation: Accepted testers
32+
Test Period: 2008/07/30 ~ 2008/08/27 (4 weeks)
33+
```
3234
-  Open Beta Test
33-
34-
` Start Date: 2008/08/27`
35-
` Server Name: Sakray Renewal Test Server`
36-
` Participation: Anyone`
37-
` Test Period: 2008/08/27 ~ 2008/09/24 (4 weeks)`
35+
```
36+
Start Date: 2008/08/27
37+
Server Name: Sakray Renewal Test Server
38+
Participation: Anyone
39+
Test Period: 2008/08/27 ~ 2008/09/24 (4 weeks)
40+
```
3841

3942
## Usage
4043

41-
[Hexed](Hexing "wikilink") kRO Sakray clients are the most used clients with [Hercules](Hercules "wikilink"), although a
44+
[Hexed](../client/hexing.md) kRO Sakray clients are the most used clients with [Hercules](../about/index.md), although a
4245
few people prefer using kRO (live server) clients or clients from different service providers.

‎docs/basics/zeny.md‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
[Zeny](Zeny "wikilink") is the in-game currency used in [Ragnarok Online](Ragnarok_Online "wikilink"), which can be used
2-
for buying and selling items from and to [NPC](NPC "wikilink") shops and other players.
1+
# Zeny
2+
3+
Zeny is the in-game currency used in [Ragnarok Online](https://en.wikipedia.org/wiki/Ragnarok_Online), which can be used
4+
for buying and selling items from and to [NPC](./npc.md) shops and other players.
35

46
## Limitation
57

68
The technical limit is for both the client and server up to 2,147,483,647 Zeny, which is typically capped at
79
1,000,000,000. The cap can be changed inside
810
[`src/common/mmo.h`](https://github.com/HerculesWS/Hercules/blob/stable/src/common/mmo.h) by adjusting the macro
9-
*MAX_ZENY* to a desired value below the technical limit. The source must be recompiled after this change. If a value is
11+
`MAX_ZENY` to a desired value below the technical limit. The source must be recompiled after this change. If a value is
1012
specified which surpasses the technical limit, the server will not compile.
1113

1214
## Penalty
@@ -21,26 +23,28 @@ amount of Zeny the player holds upon death:
2123
zeny_penalty: 0
2224
```
2325

24-
[Mapflags](Mapflag "wikilink") can be set on certain maps to disable the zeny penalty in
25-
[`conf/mapflag/nopenalty.txt`](https://github.com/HerculesWS/Hercules/blob/stable/conf/mapflag/nopenalty.txt)
26+
[Mapflags](../scripting/mapflag.md) can be set on certain maps to disable the zeny penalty in
27+
[`npc/mapflag/nopenalty.txt`](https://github.com/HerculesWS/Hercules/blob/stable/npc/mapflag/nopenalty.txt)
2628

2729
## Vending
2830

2931
The amount of Zeny that can be set to an item when vending is soft-limited to 1,000,000,000 and can be overridden by the
30-
setting *vending_max_value* in
31-
[`conf/battle/items.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/battle/items.conf) and
32-
[hexing](hexing "wikilink") the client to correct the client-side warnings.
32+
setting `vending_max_value` in
33+
[`conf/map/battle/items.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/map/battle/items.conf) and
34+
[hexing](../client/hexing.md) the client to correct the client-side warnings.
3335

34-
If the seller obtains more Zeny through vending than *MAX_ZENY* the surplus Zeny is discarded. To avoid this, the
35-
setting *vending_over_max* in
36-
[`conf/battle/items.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/battle/items.conf) can be set to
37-
*no*, which causes the deal to fail if it would result in more Zeny than the seller is able to hold.
36+
If the seller obtains more Zeny through vending than `MAX_ZENY` the surplus Zeny is discarded. To avoid this, the
37+
setting `vending_over_max` in
38+
[`conf/map/battle/items.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/map/battle/items.conf) can be set to
39+
`false`, which causes the deal to fail if it would result in more Zeny than the seller is able to hold.
3840

3941
## Scripting
4042

41-
The name *Zeny* is recognized by the script engine as a [parameter constant](parameter_constant "wikilink"), which
42-
affects the amount of Zeny of the [currently attached](RID#Usage "wikilink") player. It can be both read and written.
43+
The name `Zeny` is recognized by the script engine as a [parameter constant](../scripting/parameter-constant.md), which
44+
affects the amount of Zeny of the [currently attached](./rid.md#usage) player. It can be both read and written.
4345

44-
[`set`](set "wikilink")` Zeny,Zeny+120;  // gives the player 120z`
45-
[`mes`](mes "wikilink")` "Your current balance is "+Zeny+"z.";`
46-
[`set`](set "wikilink")` Zeny,0;  // takes all Zeny from the player`
46+
```C
47+
Zeny += 120; // gives the player 120z
48+
mesf("Your current balance is %dz.", Zeny);
49+
Zeny = 0; // takes all Zeny from the player
50+
```

0 commit comments

Comments
 (0)