readme/scripting.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
    <head>
        <title>RAthena | Scripting</title>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <link rel="stylesheet" type="text/css" href="style.css">
    </head>
    <body>
        <div id="template">
            <div id="header">
                <div class="logo">RAthena<br><span class="subtitle">- RAGNAROK Online Server Emulator</span></div>
                <div class="title">Scripting</div>
            </div>
            <div id="navcontainer">
                <ul id="navlist">
                    <li><a href="../readme.html">Intro</a></li>
                    <li><a href="setup.html">Setup</a></li>
                    <li><a href="faq.html">FAQ</a></li>
                    <li><a href="scripting.html">Scripting</a></li>
                    <li><a href="commands.html">GM Commands</a></li>
                    <li><a href="resources.html">Resources</a></li>
                </ul>
            </div>

            <div class="body-container">
                How to create an NPC using RAthena's scripting:<br><br>
                <code><font color="#0000FF">map_name</font>,<font color="#009900">x_cord</font>,<font color="#0CF305">y_cord</font>,<font color="#FF0000">npc_facing_direction</font> <strong>-TAB-</strong> script <strong>-TAB-</strong> <font color="#FF6600">NPC Name</font>#<font color="#FFCC00">HiddenName</font> <strong>-TAB-</strong> <font color="#CC3399">Sprite ID</font>,{<br>
                &nbsp;&nbsp;&nbsp;mes "[NPC Name]";<br>
                &nbsp;&nbsp;&nbsp;mes "Hello World";<br>
                &nbsp;&nbsp;&nbsp;close;<br>
                }</code><br><br>

                <strong>Common Script Commands:</strong>
                <ul>
                    <li><strong>mes</strong><br>
                        usage: mes &quot;&lt;message&gt;&quot;;<br>
                        info: displays a line of text in an NPC's dialog window.</li>
                    <li><strong>close</strong><br>
                        usage: close;<br>
                        info: displays a &quot;Close&quot; button in an NPC's dialog window.
                    </li>
                    <li><strong>next</strong><br>
                        usage: next;<br>
                        info: displays a &quot;Next&quot; button in an NPC's dialog window.
                    </li>
                    <li><strong>getitem</strong><br>
                        usage: getitem &lt;item id&gt;,&lt;amount&gt;;<br>
                        info: gives the player an item.
                    </li>
                    <li><strong>delitem</strong><br>
                        usage: delitem &lt;item id&gt;,&lt;amount&gt;;<br>
                        info: deletes an item from the player.
                    </li>
                </ul>
                <strong>Script Command Documentation:</strong><br>
                All the script commands in RAthena can be found <a href="../doc/script_commands.txt" target="_new">here</a>.<br><br>
                <strong>How to enable your NPC:</strong>
                <ol>
                    <li>Save it as a text file in your /npc/custom/ folder.</li>
                    <li>Open /npc/scripts_custom.conf</li>
                    <li>Add the following line:<br>
                    <code>npc: npc/custom/name_of_your_text_file.txt</code></li>
                    <li>Save and close.</li>
                </ol>
            </div>

            <div id="footer">"Read Me" Created &amp; Designed by <a href="http://www.kisuka.com" target="_new">Kisuka</a></div>
        </div>
    </body>
</html>