Knowledge Base

MOD-Installationsanleitung

MODs werden in der Regel als ZIP-Dateien zum Download angeboten. Diese enthalten die Installationsanleitung sowie ggf. weitere benötigte Dateien.

Die Installationsanleitung ist eine einfache Textdatei (Dateiendung meist .txt gelegentlich auch .mod) und kann mit jedem beliebigen Texteditor geöffnet werden. Die Datei ist meistens nach dem MOD benannt oder der Dateiname beinhaltet die Bezeichnung "install". Beispiel: full_album_pack_1_2_1.txt, install_german.txt

Gibt es von einem MOD mehrere Versionen, dann ist oftmals eine Updateanleitung vorhanden. Diese ist notwendig um eine installierte alte Version des MODs auf den neusten Stand zu bringen. Die Updateanleitungen sind wie eine Installationsanleitung aufgebaut und in der Regel nach der upzudatenden Version sowie dem Begriff "update" benannt. Beispiel: update_20x_to_312.txt

Sprachen und Templates
» Wenn eine oder mehrer Sprachdateien geändert werden, dann ist dies meist nur für die englischen Sprachdateien angegeben. Entsprechende Änderungen müssen natürlich für alle installierten Sprachen vorgenommen werden. Unter Umständen liegen entsprechende Anweisungen für weitere Sprachen dem MOD bei.
» Änderungen am Template werden standardmäßig nur für das Template subSilver angegeben. Ist subSilver nicht installiert oder sind weitere Templates installiert, dann müssen entsprechende Änderungen an allen installierten Templates vorgenommen werden.

Aufbau einer MOD-Installationsanleitung
Die meisten Anleitungen haben eine feste Struktur. Sie bestehen aus einem Kopfbereich, der eigentlichen Installationsanleitung und dem Ende:
Der Kopfbereich:
##############################################################
## MOD Title:           MOD-Name
## MOD Author:          Nichname <emailadresse> (Realname) Webseite
## MOD Description:     Dieser MOD fügt dem Forum...
##
## MOD Version:         x.x.x
##
## Installation Level:  Easy/Intermediate/Advanced
## Installation Time:   x Minutes
##
## Files To Edit:       x
##      datei_1
##      datei_2
##      usw.
##
## Included Files:      x
##      datei_3
##      datei_4
##      usw.
##
## License: http://opensource.org/licenses/gpl-license.php GNU General Public License v2
##############################################################
## For security purposes, please check: http://www.phpbb.com/mods/
## for the latest version of this MOD. Although MODs are checked
## before being allowed in the MODs Database there is no guarantee
## that there are no security problems within the MOD. No support
## will be given for MODs not found within the MODs Database which
## can be found at http://www.phpbb.com/mods/
##############################################################
##
## Author Notes:
##
## Weitere Infos und Hinweise des Autors zum MOD.
##
##############################################################
##
## MOD History:
##
##   YYYY-MM-DD - Version x.x.x
##      - Änderungen in dieser Version
##
##   YYYY-MM-DD - Version x.x.x
##      - Änderungen in dieser Version
##
##############################################################
## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD
##############################################################

Die eigentliche Installationsanleitung:
#
#-----[ ACTION ]------------------------------------------------
#

#
#-----[ ACTION ]------------------------------------------------
#

#
#-----[ ACTION ]------------------------------------------------
#

#
#-----[ ACTION ]------------------------------------------------
#

Das Ende:
#
#-----[ SAVE/CLOSE ALL FILES ]--------------------------------
#
# EoM

Der Kopfbereich:

MOD Title	Die Bezeichnung des MODs.
MOD Author	Infos über den Autor des MODs: phpBB.com Benutzername, Email-Adresse, realer Name, Webseite
MOD Description	Eine mehr oder minder ausführliche Beschreibung dessen was der MOD bezweckt.
MOD Version	Die Versions-Nummer des MODs. An dieser Stelle sollte kontrolliert werden, ob man auch wirklich die aktuelle Version des MODs vorliegen hat.
Installation Level	Der Schwierigkeitsgrad der MODinstallation. Er ist u.a. abhägig von der Anzahl der zu bearbeitenden Dateien und der Komplexität der erforderlichen Codeänderungen.
Installation Time	Die Zeit in Minuten, die für die Installation erforderlich ist.
Files to Edit	Die Anzahl der zu bearbeitenden phpBB-Dateien sowie eine Auflistung eben dieser Dateien.
Included Files	Die Anzahl der neu einzufügenden Dateien sowie eine Auflistung dieser Dateien.
License	Die Lizenz unter der der MOD veröffentlicht wird.
(Security Disclaimer)	Allgemeiner Sicherheitshinweis
Author Notes	Weitere Infos, Hintergrundwissen etc. zum MOD kann an dieser Stelle vorhanden sein.
MOD History	An dieser Stelle wird die Entwicklung des MODs bzw. die Änderungen am MOD dokumentiert.
(Install Disclaimer)	Dieser wichtige Hinweis sollte in jeder Anleitung vorhanden sein und vor allem auch befolgt werden. Bevor der MOD dem Board hinzugefügt wird bzw. bevor ein vorhandener MOD aktualisiert wird sollte vom gesammten Board eine Sicherung angelegt werden.

Die eigentliche Installationsanleitung:
In diesem Teil werden alle Aktionen aufgelistet, die durchgeführt werden müssen um den MOD zu installieren.

Das Ende:
Am Ende der Installationsanleitung erfolgt die Anweisung "SAVE/CLOSE ALL FILES" - d.h. alle bearbeiteten Dateien sind zu speichern und zu schließen. Zu guter Letzt müssen noch alle geänderten bzw. neuen Dateien auf die Homepage hochgeladen werden.
EoM bedeutet End of MOD (Ende des MODs)

Aktionen bei der MOD-Installation