README - NDC Code
=================

Dies ist die README fuer die GPL-Release des NDC (Northcore Deathmatch
Clan) Codes fuer Quakeserver-Administration und -Auswertung (oder
ganz kurz: NDC Code).

Die in diesem Paket gesammelten Werke sind ueber die Jahre aus
eigenem Beduerfnis bei der Verwaltung unserer Quakeserver und
der Homepage entstanden.
Meisterwerke sind nach unserer Meinung nicht dabei, aber da es
genug Leute gegeben hat, die Interesse an dem Code gezeigt
haben: nun, hier ist er.
Erwartet bitte keinen wunderschoenen und akurat durchkommentierten
Code. Ich habe versucht, die groessten Knaller rauszufeilen
(ich habe Perl und SQL gelernt, waehrend dieser Code entstand,
und das sieht man), aber teilweise sind da noch Stellen
drin, die ich selber nicht mehr verstehe.
Der gesamte Code steht von der ersten bis zur letzten Zeile
unter der GPL (GNU Public License), in voller Laenge und
Schoenheit nachzulesen in der Datei COPYING.

Was heisst das fuer Euch und uns?
(Note: Dieser Absatz ist meine Interpretation der GPL. Er ist
_keine_ Rechtsgrundlage. Gueltig ist der Wortlaut der GPL,
zu entnehmen der Datei COPYING, oder bei der FSF)
Fuer uns heisst es: was auch immer dieser Code bei Euch anrichten
mag, es ist einzig und allein Euer Problem. Wir uebernehmen keinerlei
Garantie fuer die Funktionalitaet, Sicherheit oder Brauchbarkeit
des Codes fuer irgendwelche Zwecke.
Fuer Euch heisst es: Macht damit, was ihr wollt. Veraendert ihn,
erweitert ihn, benutzt, was Euch gefaellt, und werft den Rest weg.
Dies alles unter einer Bedingung: der Code, der aus unserem oder
mit Hilfe unseres Codes entsteht, muss wieder unter der GPL stehen.
Man koennte sagen, GPL ist ansteckend. Und Heilmittel gibts keins :)
Dass abgeleiteter Code wieder unter der GPL steht, impliziert 
automatisch, daß er wieder frei verfügbar sein muss. Das heisst
_nicht_, dass ihr damit kein Geld verdienen duerft. Ihr duerft
Programme verfassen, und dafuer Geld verlangen. Aber ihr muesst
(spaetestens auf Anfrage) den Code rausruecken.


INHALT
======

Was verbirgt sich nun in den einzelnen Verzeichnissen? Eine kurze
Auflistung:

gs_analyze	Ein Perl-Script, dass die von Lithium (und anderen
		MODs) erzeugten GS-Logfiles auswertet, und in eine
		Form bringt, die die Datenbankscripte leichter ver-
		arbeiten koennen.
		Das Script erzeugt eine Gesamtstatistik, und
		Statistiken fuer einzelne Maps.

stats		Die Teile des Codes, die auf der Website im Vordergrund
		(dailystats, foreverstats, playerstats) und im Hintergrund
		(makedb, makerank) die Statistiken verwalten.

server		Das quakec5-Skript, das den Echtzeit-Status eines
		Quake2-Servers auswertet.


VORAUSSETZUNGEN
===============

Was braucht man fuer all das hier? Von den technischen Voraussetzungen
her:
perl (mindestens 5.002)
MySQL 3.22
apache 1.3

Es gibt keinen wirklichen Grund, warum das alles hier nicht auch mit
IIS und Oracle laufen sollte, aber die obige Liste stellt die laufende
Konfiguration dar, und ist als solche geprueft.

Noch etwas: die Skripte sind zwar "aus dem Leben" gegriffen, aber
natuerlich steht da auch etwas drin, was Euch nix angeht. Passworte,
Serverpfade, so ein Zeug. Das ist in diesem Release entfernt.
Das bringt es mit sich, dass moeglicherweise (oder eher: ziemlich
sicher) dieser Sourcetree nicht aus der Tuete laufen wird. Wer also
Angst vor dreckigen Fingern und anderer Leute Code hat, ist hiermit
wohl auf dem falschen Dampfer. Aber solche Personen lesen fuer gewoehnlich
auch keine READMEs :)


VERSIONIERUNG
=============

Versionsnummern? Was ist das?
Bei den fuer NDC erstellten Scripts war das nie ein grosses Thema.
Neuere Versionen wurden einfach gnadenlos in den alten Code
reingeschoben. Bei guter Laune des Autors wurde dem Dateinamen
eine sich (eventuell sogar nachvollziehbar erhoehende) angehaengte
Nummer verpasst. Diese Nummern haben sie hier auch.
Aus diesem Chaos heraus deklarieren wir alle hier mitgelieferten
Programme als Version NDC Code Release 1. Also bitte nicht wundern,
wenn es eine foreverstats3.pl gibt, aber keine Spur der vorigen
zu finden ist. Das ist dann eben so :)


KONTAKT
=======

Bei Fragen, Anregungen, Bugfixes:
http://www.ndc.sh/ndccode

oder
ndccode@ndc.sh