# FreeDoko LIESMICH

## Inhaltsverzeichnis

1. Inhaltsverzeichnis
2. Installation
   - Linux
   - Windows
3. Programmstart
   - Linux
   - Windows
4. Einstellungen
5. Dateien
6. Bemerkungen

## Installation

Dieser Teil ist nur für die Leute gedacht, die sich das Programm kompilieren wollen, die mit dem vorkompilierten Programm können direkt zu Programmstart weitergehen.

Zum Kompilieren einfach im Verzeichnis src make aufrufen. Wenn unter Linux eine Fehlermeldung mit `no-cygwin` oder `ms-bitfields` erscheint, dann hat die automatische Erkennung nicht funktioniert. Geben Sie in der Shell `export OSTYPE=linux-gnu` ein und starten Sie `make` noch einmal.

Für SuSE bitte LIESMICH.SuSE anschauen (Probleme mit DOS-Zeilenende).

Für Windows bitte LIESMICH.Windows anschauen (dlls).

Beim Kompiliervorgang werden die folgenden Variablen verwendet:

PROGNAME
  Der Name des Programms
CXX
  der C++-Kompiler
CXXFLAGS
  Flags für den C++-Compiler
CXXFLAGS
  Flags für den Präprozessor
  Je nach Betriebssystem wird noch ein `-DLINUX` bzw. ein `-DWINDOWS` hinzugefügt.
OBJ_SUFFIX
  Die Endung der Objektdateien
MINGW_DIR (nur Windows)
INCLUDE_GTKMM
LIBS_GTKMM

Wenn eine Variable nicht gesetzt ist, wird sie entsprechend der Vorgabe (s.u.) gesetzt, ansonsten wird der Wert aus der Umgebung genommen (Besonderheit: CPPFLAGS).

### Linux

PROGNAME
  FreeDoko
CXX
  g++
CXXFLAGS
  -Wall -Werror
CPPFLAGS
OBJ_SUFFIX
  o
INCLUDE_GTKMM
  `pkg-config --cflags gtkmm-2.0`
LIBS_GTKMM
  `pkg-config --libs gtkmm-2.0`

### Windows

PROGNAME
  FreeDoko.exe
CXX
  CXX ?= $(MINGW_DIR)/bin/g++
CXXFLAGS
  -mno-cygwin -mpentium -fnative-struct
CPPFLAGS
OBJ_SUFFIX
  o
MINGW_DIR
  C:/MinGW32
INCLUDE_GTK
  Ausgabe von `pkg-config --cflags gtkmm-2.0`
LIBS_GTK
  Ausgabe von `pkg-config --libs gtkmm-2.0`

## Programmstart

FreeDoko unterstützt einige Kommandozeilenargumente, diese lassen sich mit '--help' anschauen.

### Linux

Das Programm FreeDoko starten.

### Windows

Die Batch-Datei FreeDoko.bat starten.

## Einstellungen

In der Ressourcendatei FreeDokorc stehen die Einstellungen für das Programm.
Das Format ist wie folgt: Leerzeilen und Zeilen, die mit einem `'#'` beginnen werden ignoriert, Einstellungen beginnen mit dem Schlüsselwort, gefolgt von einem `'='` und dem Wert ('1' steht fuer 'ja', '0' fuer 'nein');

Alle Einstellungen können wärend des Spiels geändert werden und werden sofort aktiv.

## Dateien

Zu FreeDoko gehöhren folgende Dateien:

Programmdatei
  Unter Linux ist dies FreeDoko, unter Windows FreeDoko.exe.
Bibliotheken (nur Windows) (Unterverzeichnis gtkmm.dll)
  Die GTKMM-Bibliotheken müssen beim Programmstart im Pfad liegen.
  Diese Dateien stammen von http://www.gtkmm.org/.
Einstellungen (Datei FreeDokorc)
  In dieser Datei stehen die Einstellungen für FreeDoko.
Graphiken (Unterverzeichnis graphics)
  Altenburg-Karten (Unterverzeichnis Altenburg/french)
    Kartengraphiken (Unterverzeichnis cards)
      Dieses Verzeichnis besteht aus den Verzeichnissen club, spade, hearts und diamond.
      In den Verzeichnissen club, spade, hearts und diamond befinden sich die Graphiken für die entsprechenden Karten nine.xpm, jack.xpm, queen.xpm, king.xpm, ten.xpm sowie ace.xpm.
    Kartenrückseite (Unterverzeichnis back)
      Im Verzeichnis backs befinden sich Kartenhintergründe.
    Symbole (Unterverzeichnis icons)
      Im Verzeichnis icons befinden sich die Symbole.
  Hintergründe (Unterverzeichnis backgrounds)
    Dieses Verzeichnis enthält die Hintergründe für die Spielfläche.
Sounds (Unterverzeichnis sounds)
  Hier befinden sich die Sounds als wav-Dateien (noch zu machen).
Textdateien (Unterverzeichnis translations)
  In den Unterverzeichnissen (bisher de und en) befinden sich in der Datei text (fast) alle Texte, die das Programm benötigt.
Dokumentation (Unterverzeichnis doc)
  Dieses Verzeichnis enthält verschiedene Dokumentation:
  GPL
    Die GPL (GNU GENERAL PUBLIC LICENSE), die Lizens, unter der FreeDoko steht.
  Bugs
    Bekannte Fehler (siehe auch auf die Sourceforge-Seite http://sourceforge.net/tracker/?atid=421197&group_id=38051&func=browse und http://free-doko.sourceforge.net/de/doc/manual/de/bugs.html).
  ToDo
    Was wir noch machen wollen
  deutsche Dokumentation (Unterverzeichnis de)
    Verzeichnis mit deutscher Dokumentation
  englische Dokumentation (Unterverzeichnis en)
    Verzeichnis mit englischer Dokumentation
  Handbuch (Unterverzeichnis manual)
    Dieses Verzeichnis enthält das Handbuch in den Sprachen deutsch und englisch.

## Bemerkungen

- Diese Version ist noch alpha, das heißt sie ist noch nicht vollständig.
- Bei Fehlern bitte eine Mail an freedoko@users.sourceforge.net schicken.