______ _______ ______ __           __              
 |   __ \       |   __ \  |__ _____ |  |_ _____ ____
 |      <   -   |      <  _  |  _  ||   _|  -__|   _|
 |___|__|_______|___|__|_____|_____||____|_____|__|  
                                                    
 RORboter    version: 0.031    build: 392    release: 02
 type: freiware (clanintern *g*)  release date: 28.01.03
 by cha0s -  rorboter@chaosquake.de -  www.chaosquake.de

___ inhalt _____________________________________________
. wtf ? -------------------------- wozu das ganze gut is
. voraussetzung  ---------------------- was brauch ich ?
. files -------------- des RORboters und dessen aufgaben
. installation ------------------------ kleine anleitung
. user frontend --------------------- einige anmerkungen
. sonstiges ---------------------- noch mehr anmerkungen
. changelog ---------------------- was sich geändert hat


___ wtf ? ______________________________________________
der RORboter ist ein php-script welches das browsergame
RoR (www.ror.de.tf) für euch "spielt". jeder user hat
einen stack, in dem alle actions abgelegt sind, die vom
script nacheinander ausgeführt werden sollen.


___ voraussetzung ______________________________________
. apache oder einen anderen webserver --- www.apache.org
. php4 (register_globals: on !) ------------ www.php.net
. mysql ---------------------------------- www.mysql.com
. phpmyadmin ------------------------ www.phpmyadmin.net


___ files ______________________________________________
. index.php - das user frontend. hier loggt ihr euch ein
  und ändert euren stack.

. rorboter.php - der RORboter server. muss in einem
  explorer fenster geöffnet sein. dieses fenster wird
  automatisch alle 10mins refreshed (neu geladen) und
  führt dann die actions im stack aus.

. monitor.php - eine simple ausgabe der logfiles.
  mit "monitor.php?date=26-01" könnt ihr ein log file
  wählen. ansonsten wird immer das log des tages 
  ausgegeben.

. setup.php - richtet die sql tables ein.

. save.php speichert die infos die in index.php eingeben
  wurden. diese datei braucht/solltet ihr NICHT "per
  hand" ausführen !

. /logs - alle actionen des RORboters werden geloggt.
  im logs verzeichnis findet ihr ein log für jeden tag.

. /gfx - grafiken und includes.

. /gfx/sqlsettings.php - name ist programm.


___ installation _______________________________________
wie ihr apache etc. installiert werd ich hier nich 
erklären !
das script sollte seinen eigenen ordner (rorboter)im 
htdocs folder haben. ändert zunächst sqlsettings.php 
im gfx ordner. sollte selbsterklärend sein. führt 
anschliesend die setup.php aus, diese legt 2 tables in
der db an (rormember, roraction).
als nächstes müsst ihr euch einen user im rormember 
table anlegen. macht das mit phpmyadmin. die felder
id, stack u. waittime lasst ihr frei (= name + pass
eintragen). name + pass entsprechen den login daten für
RoR ! dh. der login für den RORboter ist der gleiche wie
für das spiel.

ab RORboter 0.031 ist ein mysql-dump des roraction 
tables enthalten. dieser dump beinhaltet 28 gebäude,
alle 12 forschungen u. 6 x-actions. der dump installiert
sich mit dem ausführen der setup.php.


wenn ihr noch weitere actions hinzufügen wollt macht das
wieder mit phpmyadmin. nehmen wir an ihr wollt eine 
wohnanlage eintragen: 

name: wohnanlage 
action: buildings_bauen&gid=1
waittime: 5

"name" ist einfach der name der später im frontend 
angezeigt wird. um das ganze etwas mehr zu strukturieren 
könnt ihr also auch sowas wie "bauen: wohnanlage" als 
namen angeben.

die lustige "action" (buildings_bauen&gid=1) könnt ihr 
durch alle actions die RoR kennt ersetzen. 
"research_forschen&fid=1" wäre also zb. "viren forschen"
demnach ist es auch möglich per RORboter andere spieler
anzugreifen (nicht getestet !). 
das script guckt lediglich ob ein "NICHT" o. "nicht"
im zurückgegebenen html code enthalten ist. ist dies 
nicht der fall, so wird angenommen das die action  
geglückt ist, und die nächste action rutscht nach.
wenn bei anderen seiten also kein "nicht" vorhanden ist,
obwohl die action nicht ausgeführt werden konnte, wird
die action einfach gelöscht, ohne das sie ausgeführt 
wurde. (0_o stazbau *g*)
dieses verfahren mit dem "nicht" im array wurde nur mit
forschungen und gebäuden getestet !

"waittime" ist die zeit in ticks, die das script wartet 
bevor es sich erneut einloggt. die waittime wird gesetzt 
sobald die action erfolgreich abgeschlossen wurde. bei 
forschungen könnt ihr als waittime zb. auch 0 angeben - 
das hat allerdings den nachteil, dass sich das script 
alle 10minuten einloggt = 144mal am tag !
zusätzlich dazu könnt ihr auch noch im user-frontend
eine waittime einstellen. dh. wenn ihr pennen geht,
vorher aber noch ein gebäude "manuel" gebaut habt, könnt
eine waittime eintragen. das script wird dann erst nach
dieser waittime "aktiv".


___ user frontend ______________________________________
. das user/pass is nicht etwa da um euch zu verifizieren
  (geiles wort *g*) sondern um den username und password
  zu ändern.

. clear stack löscht den gesammten stack und setzt die 
  waittime auf 0. es wird nich nochmal gefragt ob ihr
  sicher seid !

. wenn ihr irgendeine action mitten aus dem stack 
  löschen wollt, könnt ihr diese einfach auf "no action"
  setzen. die anderen actions werden automatisch nach-
  rutschen.


___ sonstiges __________________________________________
. der code ist scheisse. versucht erst garnich was von 
  zu lernen.

. drückt NIE F5 oder refresh im server window.
  dadurch wird das meta-refresh (das automatische neu
  laden) ausser kraft gesetzt.
  ruft die rorboter.php nur einmal auf und drückt auch
  nicht mehrmals "wechseln zu". vileicht is es bei 
  anderen browsern nich so scheisse wie beim IE. ka.

. der RORboter ist immernoch multiuser fähig. einfach 
  einen weiteren user in die db eintragen. den rest geht
  automatisch - vorsicht vor admins ;)

. wenn euch 20 actions zu wenig sind, müsst ihr nur in
  save.php (zeile 7) und index.php (zeile 17) die zahlen
  ändern. die zu ladende datenmenge is allerdings jetzt
  schon enorm gross (ca.80kb html !) und wird durch jede
  action weiter steigen ...

. wenn bei irgendwelchen actions die misglückt sind kein
  "nicht" zurückgegeben wird, so könnt ihr in der
  rorboter.php (zeile 39) weitere schlüsselwörter hinzu-
  fügen. spasten: finger weg !

. beta testing war nicht vorhanden. ich garantiere für
  nix. (dieses zeilen sollten genauer gelesen werden
  als bei anderen programmen)


___ changelog __________________________________________

 + added
 - removed
 ~ changed

v.0.31 . release: 02 date: 28.01.03
       + mysql dump mit 28 gebäuden, 12 forschungen u.
         6 x-actions (man klingt das kuhl)
       + stack runtime im client window
       + clear stack function
       ~ kein logout nach save o. clear stack
       ~ charlänge von "action" erhöht
       ~ bessere farben
       ~ neus readme design o_0

v.0.21 . release: 01 date: 26.01.03
       + alles