Mercurial > hg > batmud > ggrtf
changeset 1544:539af86668a9
Some DocBook validation fixes.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Thu, 18 Apr 2013 05:39:05 +0300 |
| parents | f804e1c83a41 |
| children | fe83084ff7e1 |
| files | README.txt docs/manual.sgml |
| diffstat | 2 files changed, 121 insertions(+), 98 deletions(-) [+] |
line wrap: on
line diff
--- a/README.txt Thu Apr 18 05:15:39 2013 +0300 +++ b/README.txt Thu Apr 18 05:39:05 2013 +0300 @@ -28,9 +28,18 @@ Mercurial repository : http://pupunen.net/hg/ggrtf/ +Release Notes for v0.7.1.1 +-------------------------- +For full list of changes, refer to "ChangeLog". + +Changes from v0.7.1.0: + + * + + + Release Notes for v0.7.1.0 -------------------------- -For full list of changes, refer to "ChangeLog". Changes from v0.7.0.1: @@ -41,9 +50,6 @@ hit statistics module. -Release Notes for v0.7.0.0 --------------------------- - Changes from v0.6.18.3: * Various additions in spellname translator.
--- a/docs/manual.sgml Thu Apr 18 05:15:39 2013 +0300 +++ b/docs/manual.sgml Thu Apr 18 05:39:05 2013 +0300 @@ -436,11 +436,9 @@ <para> You can download (aka "clone") the GgrTF repository with command line Mercurial client with following command: -</para> <userinput>hg clone &hgrepourl; dest_dir</userinput> -<para> In which <emphasis>"clone"</emphasis> means making a local copy of the repository under directory <emphasis>dest_dir</emphasis>. </para> @@ -450,11 +448,9 @@ specific place, personally I prefer to use ~/ggrtf/ (aka "ggrtf/" under user's home directory) under UNIX. Thus typically you would use following command: -</para> <userinput>hg clone &hgrepourl; ~/ggrtf</userinput> -<para> If you are using Windows, and wish to use the development version, you can use the regular Mercurial command line client, or a GUI interface such as <ulink url="http://tortoisehg.bitbucket.org/">TortoiseHg</ulink>. @@ -465,11 +461,9 @@ are otherwise similar, except the directory/folder path is different, under Windows XP the path would be <emphasis>C:\Documents and Settings\<username>\ggrtf\</emphasis>. For example, if your username is "Ggr", you could use the following command: -</para> <userinput>hg clone &hgrepourl; "C:\Documents and Settings\Ggr\ggrtf\"</userinput> -<para> Under Windows Vista and 7, the path is of the format <emphasis>C:\Users\<username>\</emphasis> </para> @@ -480,16 +474,11 @@ After you have checked out your own copy of GgrTF's code repository, you usually wish to periodically update it. This is done easily with the following commands: -</para> <userinput>cd ~/ggrtf</userinput> - <userinput>hg pull</userinput> - <userinput>hg update</userinput> - -<para> Notice that since Mercurial is a distributed version management system, you can easily keep your own local changes by committing them (<emphasis>'hg ci'</emphasis>) and then, instead of using 'pull' and 'update', you can use 'hg fetch' to merge @@ -750,46 +739,47 @@ </para> <itemizedlist> - <listitem><para>Line 'cutter' setting:</para> + <listitem><para>Line 'cutter' setting: <userinput>cutter 9999</userinput> -<para>Theoretically, '<emphasis>cutter off</emphasis>' +Theoretically, '<emphasis>cutter off</emphasis>' should be better, but in practice I have noticed that in certain things it simply does not work as expected.</para> </listitem> - <listitem><para>Short score format for regular BatMUD:</para> + <listitem><para>Short score format for regular BatMUD: <userinput>@@sc set H:{colorhp}/<maxhp> [{diffhp}] S:{colorsp}/<maxsp> [{diffsp}] E:{colorep}/<maxep> [{diffep}] $:<cash> [{diffcash}] exp:<exp> [{diffexp}]</userinput> +</para> </listitem> - <listitem><para>Short score format for HardCore BatMUD (HCBat):</para> + <listitem><para>Short score format for HardCore BatMUD (HCBat): <userinput>@@sc set H:{colorhp}/<maxhp> S:{colorsp}/<maxsp> E:{colorep}/<maxep> $:<cash> exp:<exp></userinput> +</para> </listitem> - - <listitem><para>Enable automatic short score (required for automatic updating of HP/SP/EP values on statusline):</para> + <listitem><para>Enable automatic short score (required for automatic updating of HP/SP/EP values on statusline): <userinput>@@sc on</userinput> +</para> <note><para>If you do not wish to not see the 'sc' lines, you can turn on '/gagsc' option.</para></note> </listitem> - - <listitem><para>Prompt</para> + <listitem><para>Prompt: <userinput>@@prompt PROMPT:></userinput> -<para>If you wish, you can add any BatMUD specific data to the prompt +If you wish, you can add any BatMUD specific data to the prompt between ":" and ">", this substring will be stored to "status_prompt" TF variable, which can be used in /gprompt. Read more in <link linkend="usage-general-prompt">prompt setup section</link>.</para> </listitem> - <listitem><para>Listen to battle round flags:</para> + <listitem><para>Listen to battle round flags: <userinput>@@battle rounds</userinput> -<para>This setting is a toggle, make sure that you set it ON +This setting is a toggle, make sure that you set it ON ("Listening to round flags.") instead of off! </para> </listitem> - <listitem><para>Battle listen-level:</para> + <listitem><para>Battle listen-level: <userinput>@@battle listen all 2</userinput> -<para>Listen level should be 2 or 3, if you are using hitstats. +Listen level should be 2 or 3, if you are using hitstats. Otherwise it can be 1 or 0, if you prefer silence. </para> </listitem> @@ -1071,11 +1061,9 @@ To get started, you need to have a basic prompt setting in BatMUD, as it is required to have GgrTF handle it properly. The basic setting is presented below, and we'll get to the more complex ones later. -</para> <userinput>prompt PROMPT:></userinput> -<para> After setting the BatMUD prompt, you can start configuring how GgrTF "mangles" your prompt. This is done by using "/gprompt" command macro (or alternatively editing the saved configuration files and "set_gprompt" @@ -1084,16 +1072,31 @@ </para> <orderedlist> - <listitem><userinput>/gprompt ></userinput><para>Set prompt to show only -">" and nothing more</para></listitem> - <listitem><userinput>/gprompt %{status_cast}></userinput><para> -Show currently in-progress skill or spell in prompt.</para></listitem> - <listitem><userinput>/gprompt @{BCred}%{status_cast}@{n}@{BCwhite}>@{n}</userinput><para> -TinyFugue color attributes can be used also.</para></listitem> - <listitem><userinput>/gprompt @{$[prgetnlite(status_hp,status_hpm)]}%{status_hp}@{n}@{BCwhite}>@{n}</userinput><para> -Above would print your hp, lited similarly to the statusbar HP/SP/EP display. -It is possible to use almost any kind of substitutions and call TF functions. -</para></listitem> + <listitem> + <para> + <userinput>/gprompt ></userinput> + Set prompt to show only ">" and nothing more. + </para> + </listitem> + <listitem> + <para> + <userinput>/gprompt %{status_cast}></userinput> + Show currently in-progress skill or spell in prompt. + </para> + </listitem> + <listitem> + <para> + <userinput>/gprompt @{BCred}%{status_cast}@{n}@{BCwhite}>@{n}</userinput> + TinyFugue color attributes can be used also. + </para> + </listitem> + <listitem> + <para> + <userinput>/gprompt @{$[prgetnlite(status_hp,status_hpm)]}%{status_hp}@{n}@{BCwhite}>@{n}</userinput> + Above would print your hp, lited similarly to the statusbar HP/SP/EP display. + It is possible to use almost any kind of substitutions and call TF functions. + </para> + </listitem> </orderedlist> <note><para> @@ -1109,28 +1112,33 @@ As you remember, we set up the basic prompt above to "PROMPT:>". The user definable data can be put between the colon (":") and greater than (">") sign, and it gets parsed by GgrTF. Observe following example: -</para> <userinput>prompt PROMPT:<hp>/<sp>/<ep>|<eqset>></userinput> -<para> Above prompt setting would make the BatMUD prompt show something like: -</para> <userinput>PROMPT:663/636/333|spr></userinput> -<para>Where the numbers represent your hp, sp and ep, and 'spr' is the work +Where the numbers represent your hp, sp and ep, and 'spr' is the work eqset, as described by 'help prompt'. This string gets parsed into a TF variable called "status_prompt", which can be then used in GgrTF's prompt. Examples follow: </para> <orderedlist> - <listitem><userinput>/gprompt %{status_prompt}></userinput> - <para>This simple example would just prompt the grabbed BatMUD data with - greater than sign in the end.</para></listitem> - <listitem><userinput>/gprompt @{BCgreen}%{status_prompt}@{n}></userinput> - <para>Same as above, but coloured bright green.</para></listitem> + <listitem> + <para> + <userinput>/gprompt %{status_prompt}></userinput> + This simple example would just prompt the grabbed BatMUD data with + greater than sign in the end. + </para> + </listitem> + <listitem> + <para> + <userinput>/gprompt @{BCgreen}%{status_prompt}@{n}></userinput> + Same as above, but coloured bright green. + </para> + </listitem> </orderedlist> <para> @@ -1320,17 +1328,16 @@ define a hook, which is executed when TF disconnects from a world. By setting this hook to perform "/gsave", we can automatize the process of saving settings. Add following line to your TF configuration: -</para> <userinput>/def -hDISCONNECT mydisconnect = /gsave</userinput> -<para> There is one gotcha: if you don't want to keep saving the statistical values, but only the settings, you may want to add a "/greset" in the soup: -</para> <userinput>/def -hDISCONNECT mydisconnect = /greset%;/gsave</userinput> +</para> + </section> @@ -1399,46 +1406,52 @@ </para> <itemizedlist> - <listitem><para> - <emphasis>Limitations of TF's parsing</emphasis>: - Because of the nature how bindings are defined and parsed, - you can only use one binded command per line. - For example, let's assume "aoa" is binding to cast Armour of Aether - and "clair" is a binding to use clairvoyance. Thus, someone - might want to command: + <listitem> + <para> + <emphasis>Limitations of TF's parsing</emphasis>: + Because of the nature how bindings are defined and parsed, + you can only use one binded command per line. + For example, let's assume "aoa" is binding to cast Armour of Aether + and "clair" is a binding to use clairvoyance. Thus, someone + might want to command: + + <userinput>aoa ggr%;clair</userinput> + + Unfortunately, this does not work as might be expected. Because TF does + not evaluate binding as an expression, the "ggr%;clair"-part + is used as a literal argument to "aoa" binding. In effect the + command would try to cast Armour of Aether at player "ggr%;clair". </para> - <userinput>aoa ggr%;clair</userinput> + </listitem> + + <listitem> <para> - Unfortunately, this does not work as might be expected. Because TF does - not evaluate binding as an expression, the "ggr%;clair"-part - is used as a literal argument to "aoa" binding. In effect the - command would try to cast Armour of Aether at player "ggr%;clair". - </para></listitem> - - <listitem><para> - <emphasis>BatMUD commands and GgrTF bindings cannot be mixed</emphasis>: - Because the bindings are actually intercepted by TF before the line gets - passed to BatMUD's parser, you can't combine multiple bindings or BatMUD - commands on the line. For example, assuming "aoa" is again a binding - and "hop" is an emote: + <emphasis>BatMUD commands and GgrTF bindings cannot be mixed</emphasis>: + Because the bindings are actually intercepted by TF before the line gets + passed to BatMUD's parser, you can't combine multiple bindings or BatMUD + commands on the line. For example, assuming "aoa" is again a binding + and "hop" is an emote: + + <userinput>hop jeskko;aoa ggr</userinput> + + One might easily assume, that the result would be to first hop + around player or thing named Jeskko, and then cast Armour of Aether + at Ggr. Unfortunately the latter would just produce an error, as + it would be instead passed to BatMUD's interpreter and not handled + as a binding by TF! </para> - <userinput>hop jeskko;aoa ggr</userinput> + </listitem> + + <listitem> <para> - One might easily assume, that the result would be to first hop - around player or thing named Jeskko, and then cast Armour of Aether - at Ggr. Unfortunately the latter would just produce an error, as - it would be instead passed to BatMUD's interpreter and not handled - as a binding by TF! - </para></listitem> - - <listitem><para> - <emphasis>Limitations of GgrTF's binding system</emphasis>: - There are certain limitations what kind of bindings you can define - with the current functionality provided by GgrTF. Bindings that - require complex parameters (more than one optional argument), - are not possible - you are better off using BatMUD's command - aliases for those. - </para></listitem> + <emphasis>Limitations of GgrTF's binding system</emphasis>: + There are certain limitations what kind of bindings you can define + with the current functionality provided by GgrTF. Bindings that + require complex parameters (more than one optional argument), + are not possible - you are better off using BatMUD's command + aliases for those. + </para> + </listitem> </itemizedlist> @@ -3023,11 +3036,9 @@ <para> Default location of the results text file is user's home directory, in file called <emphasis>alch_results.txt</emphasis>, but this can be changed by altering <emphasis>galch_file</emphasis> TF variable, for example: -</para> <userinput>/eval /set galch_file=%{HOME}/someotherfile.txt</userinput> -<para> You should put this, if you wish to, in your tfrc file AFTER the loading of alchemist module. </para> @@ -3436,14 +3447,20 @@ </para> <itemizedlist> - <listitem><para>Retrieve Matti Hämäläinen's public key from a keyserver:</para> -<userinput>gpg --keyserver wwwkeys.pgp.net --recv-keys 0x1374C112</userinput> -</listitem> - <listitem><para>Verify the package signature (assuming you have downloaded both the file and signature):</para> -<userinput>gpg --verify ggrtf-&ggrtfver;.tar.gz.asc</userinput> -<para>If the data is untampered, you should get a result like 'gpg: Good -signature from "Matti Hamalainen (ccr) <ccr@tnsp.org>"'</para> -</listitem> + <listitem> + <para> + Retrieve Matti Hämäläinen's public key from a keyserver: + <userinput>gpg --keyserver wwwkeys.pgp.net --recv-keys 0x1374C112</userinput> + </para> + </listitem> + <listitem> + <para> + Verify the package signature (assuming you have downloaded both the file and signature): + <userinput>gpg --verify ggrtf-&ggrtfver;.tar.gz.asc</userinput> + If the data is untampered, you should get a result like 'gpg: Good + signature from "Matti Hamalainen (ccr) <ccr@tnsp.org>"' + </para> + </listitem> </itemizedlist> <para>