Mercurial > hg > batmud > ggrtf
changeset 284:6517558e2516
Cleanups.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Sat, 18 Feb 2006 01:44:55 +0000 |
parents | 496c2c457cb1 |
children | 848a9c75d9d0 |
files | docs/manual.sgml |
diffstat | 1 files changed, 42 insertions(+), 27 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/manual.sgml Fri Feb 17 04:19:09 2006 +0000 +++ b/docs/manual.sgml Sat Feb 18 01:44:55 2006 +0000 @@ -112,33 +112,25 @@ <section id="whatisggrtf"><title>What is GgrTF?</title> <para> -It would be hard to completely describe what GgrTF is as a whole, but I -like to think about it as a framework for triggers/macros for &tfurl; -MUD-client to ease playing of &batmudurl;. What differentiates GgrTF from -most other publicly available triggersets, is how it is laid -out reasonably well for is modularity and has been designed from -ground-up as framework for easy extending. Many other publicly available -scripts are either old, poorly maintained or hastily designed. GgrTF -aims to remedy at least the design part, whether other aspects of -improvement will be fulfilled, remains to be seen. +It is hard to give a short, but comprehensive description of what +GgrTF is as a whole, but I like to think about it as a framework for +triggers to ease playing of &batmudurl; with &tfurl; MUD-client. +GgrTF is designed for modularity and easy extending, good +overall quality of code and maintainability. These are also +some of the key elements, that differentiate GgrTF from most +other publicly available scripts. </para> <para> -It must be admitted that GgrTF is a somewhat programmer-oriented, it is -not all that well documented (although we are trying remedy that) and -most likely requires knowledge of how &tfurl; and its macro language -works. As such GgrTF is not a ready out-of-the-box experience and -never will be. Some other scripts may offer more in the automation -and pre-made hook department, GgrTF's aims are different, however. +GgrTF is being developed and meant to be used on version 4 of &tfurl; +MUD client. It <emphasis>should</emphasis> work with TF version 5, +too, but may require some modifications. Officially only TF4 is +"supported", so any problems with TF5 you can keep for yourself. + so please do not report "incompatibility" warnings +given by TF5, unless you know what you are doing. </para> <para> -That being said, I do know some people who have no TF-scripting experience -to begin with, but are using GgrTF anyway. If you know how to install -and setup &tfurl; properly, GgrTF should not be too hard to set up either. -</para> - -<para> The current version (as of &ggrtfver; release) has modules for following character classes: </para> @@ -168,12 +160,26 @@ <section id="isggrtfforme"><title>Is GgrTF for Me?</title> <para> -Impossible to tell, really. When I started working on GgrTF, I was just -"scratching an itch", an itch that still continues. +It is impossible to tell, really. When I started working on GgrTF, +I was just "scratching an itch", an itch that still continues. During the two years I have been developing GgrTF, most of that time I've been scratching my own back, doing stuff for myself. -Only lately, after Jeskko sneakily joined the project, I have -been working on some features that do not directly benefit me. +Thus, if you like the design decisions and features I like, +play the same guilds as I (though some guilds which I haven't +ever touched are supported through efforts of other developers, +like Jeskko) it is likely that you will like GgrTF. +</para> + +<para> +It must be admitted that GgrTF is a somewhat programmer-oriented, it is +not all that well documented (although we are trying remedy that) and +most likely requires knowledge of how &tfurl; and its macro language +works. As such GgrTF is not a ready out-of-the-box experience and +never will be. Some other scripts may offer more in the automation +and pre-made hook department, GgrTF's aims are different, however. +For example, one reason for this user's manual was created, was to +help you to understand internals of GgrTF and give a head start +in customizing it to suit your personal preferences. </para> <para> @@ -183,6 +189,7 @@ out there for those who do not find it satisfactory. Below I have tried to list some pros and cons of using GgrTF. </para> + <itemizedlist> <listitem><para>Pros:</para> <itemizedlist> @@ -197,10 +204,9 @@ <listitem><para>Cons:</para> <itemizedlist> <listitem><para>Only small number of &batmudurl;'s guilds are specifically supported.</para></listitem> + <listitem><para>Requires more knowledge about programming some other solutions.</para></listitem> <!-- <listitem><para></para></listitem> - <listitem><para></para></listitem> - <listitem><para></para></listitem> --> </itemizedlist> </listitem> @@ -1409,6 +1415,15 @@ <listitem><para>Tick predictor does not work. No, please don't ask.</para></listitem> <listitem><para>Hitstats (/hstats) has some problems.</para></listitem> + + <listitem><para>&tfurl; version 5 contains various changes, which obsolete +some techniques used in current GgrTF's code. This will cause TF5 to spew +few warnings. Feel free to fix these yourself, we (the developers) are +using TF4 and have no plans to "upgrade" anytime soon.</para></listitem> + +<!-- + <listitem><para></para></listitem> +--> </itemizedlist> </section>