README

   1 README - NDC Code
   2 =================
   3
   4 Dies ist die README fuer die GPL-Release des NDC (Northcore Deathmatch
   5 Clan) Codes fuer Quakeserver-Administration und -Auswertung (oder
   6 ganz kurz: NDC Code).
   7
   8 Die in diesem Paket gesammelten Werke sind ueber die Jahre aus
   9 eigenem Beduerfnis bei der Verwaltung unserer Quakeserver und
  10 der Homepage entstanden.
  11 Meisterwerke sind nach unserer Meinung nicht dabei, aber da es
  12 genug Leute gegeben hat, die Interesse an dem Code gezeigt
  13 haben: nun, hier ist er.
  14 Erwartet bitte keinen wunderschoenen und akurat durchkommentierten
  15 Code. Ich habe versucht, die groessten Knaller rauszufeilen
  16 (ich habe Perl und SQL gelernt, waehrend dieser Code entstand,
  17 und das sieht man), aber teilweise sind da noch Stellen
  18 drin, die ich selber nicht mehr verstehe.
  19 Der gesamte Code steht von der ersten bis zur letzten Zeile
  20 unter der GPL (GNU Public License), in voller Laenge und
  21 Schoenheit nachzulesen in der Datei COPYING.
  22
  23 Was heisst das fuer Euch und uns?
  24 (Note: Dieser Absatz ist meine Interpretation der GPL. Er ist
  25 _keine_ Rechtsgrundlage. Gueltig ist der Wortlaut der GPL,
  26 zu entnehmen der Datei COPYING, oder bei der FSF)
  27 Fuer uns heisst es: was auch immer dieser Code bei Euch anrichten
  28 mag, es ist einzig und allein Euer Problem. Wir uebernehmen keinerlei
  29 Garantie fuer die Funktionalitaet, Sicherheit oder Brauchbarkeit
  30 des Codes fuer irgendwelche Zwecke.
  31 Fuer Euch heisst es: Macht damit, was ihr wollt. Veraendert ihn,
  32 erweitert ihn, benutzt, was Euch gefaellt, und werft den Rest weg.
  33 Dies alles unter einer Bedingung: der Code, der aus unserem oder
  34 mit Hilfe unseres Codes entsteht, muss wieder unter der GPL stehen.
  35 Man koennte sagen, GPL ist ansteckend. Und Heilmittel gibts keins :)
  36 Dass abgeleiteter Code wieder unter der GPL steht, impliziert
  37 automatisch, daß er wieder frei verfügbar sein muss. Das heisst
  38 _nicht_, dass ihr damit kein Geld verdienen duerft. Ihr duerft
  39 Programme verfassen, und dafuer Geld verlangen. Aber ihr muesst
  40 (spaetestens auf Anfrage) den Code rausruecken.
  41
  42
  43 INHALT
  44 ======
  45
  46 Was verbirgt sich nun in den einzelnen Verzeichnissen? Eine kurze
  47 Auflistung:
  48
  49 gs_analyze      Ein Perl-Script, dass die von Lithium (und anderen
  50                 MODs) erzeugten GS-Logfiles auswertet, und in eine
  51                 Form bringt, die die Datenbankscripte leichter ver-
  52                 arbeiten koennen.
  53                 Das Script erzeugt eine Gesamtstatistik, und
  54                 Statistiken fuer einzelne Maps.
  55
  56 stats           Die Teile des Codes, die auf der Website im Vordergrund
  57                 (dailystats, foreverstats, playerstats) und im Hintergrund
  58                 (makedb, makerank) die Statistiken verwalten.
  59
  60 server          Das quakec5-Skript, das den Echtzeit-Status eines
  61                 Quake2-Servers auswertet.
  62
  63
  64 VORAUSSETZUNGEN
  65 ===============
  66
  67 Was braucht man fuer all das hier? Von den technischen Voraussetzungen
  68 her:
  69 perl (mindestens 5.002)
  70 MySQL 3.22
  71 apache 1.3
  72
  73 Es gibt keinen wirklichen Grund, warum das alles hier nicht auch mit
  74 IIS und Oracle laufen sollte, aber die obige Liste stellt die laufende
  75 Konfiguration dar, und ist als solche geprueft.
  76
  77 Noch etwas: die Skripte sind zwar "aus dem Leben" gegriffen, aber
  78 natuerlich steht da auch etwas drin, was Euch nix angeht. Passworte,
  79 Serverpfade, so ein Zeug. Das ist in diesem Release entfernt.
  80 Das bringt es mit sich, dass moeglicherweise (oder eher: ziemlich
  81 sicher) dieser Sourcetree nicht aus der Tuete laufen wird. Wer also
  82 Angst vor dreckigen Fingern und anderer Leute Code hat, ist hiermit
  83 wohl auf dem falschen Dampfer. Aber solche Personen lesen fuer gewoehnlich
  84 auch keine READMEs :)
  85
  86
  87 VERSIONIERUNG
  88 =============
  89
  90 Versionsnummern? Was ist das?
  91 Bei den fuer NDC erstellten Scripts war das nie ein grosses Thema.
  92 Neuere Versionen wurden einfach gnadenlos in den alten Code
  93 reingeschoben. Bei guter Laune des Autors wurde dem Dateinamen
  94 eine sich (eventuell sogar nachvollziehbar erhoehende) angehaengte
  95 Nummer verpasst. Diese Nummern haben sie hier auch.
  96 Aus diesem Chaos heraus deklarieren wir alle hier mitgelieferten
  97 Programme als Version NDC Code Release 1. Also bitte nicht wundern,
  98 wenn es eine foreverstats3.pl gibt, aber keine Spur der vorigen
  99 zu finden ist. Das ist dann eben so :)
 100
 101
 102 KONTAKT
 103 =======
 104
 105 Bei Fragen, Anregungen, Bugfixes:
 106 http://www.ndc.sh/ndccode
 107
 108 oder
 109 ndccode@ndc.sh