Readme-Generator

Dein Plugin ist fertig und kann released werden, nur was muss jetzt eigentlich alles genau in die readme.txt?

Wir haben die sehr hilfreiche Idee von LHammonds aufgegriffen und eine deutschsprachige Variante eines Readme-Generators für die TES-Community erstellt. Nun kannst du sicher sein, dass in deiner Readme alle wichtigen Punkte berücksichtigt sind und jeder sich mit den Hinweisen zu deinem Plugin gut zurecht finden kann. Zudem sind die mit unserem Generator erstellten Readme-Texte übersichtlich sowie von vergleichbarem Aufbau und jeder weiß gleich, wo sich der gesuchte Unterpunkt auf den ersten Blick finden lässt. Wenn das nicht praktisch ist - und die Spieler werden zufrieden sein!

 

Anleitung Readme-Generator:

• Fülle bitte einfach das Formular genau aus (Optionen wählen und deine Beschreibungen eingeben)  und klick dann auf "Readme erstellen". Auf einer neuen Seite erscheinen deine Angaben als neuer Text.

• Felder, die leer bleiben, erscheinen nicht im Text der Readme, alle weiteren tragen die Überschriften, wie du sie hier siehst.

• Mit dem Zurück-Button deines Browsers kannst du zurück zum Generator, ggf. nochmals Änderungen vornehmen und den Text erneut erstellen.

• Danach kannst du den fertig erstellten Text kopieren, in eine *.txt, *.doc, *.rtf oder *.pdf übertragen und deinem Plugin-Ordner vor dem Packen hinzufügen!

• Der kopierte Text kann in deiner Datei auf deinem Rechner natürlich nochmals überarbeitet werden.

Darüber hinaus kannst du einige Unterpunkte deiner Wahl auch gleich für die Beschreibung des Plugins im entsprechenden Release-Thread (oder auch für einen Mod-Vorstellungs-Thread) verwenden.

Benötigte Angaben für einen übersichtlichen Release-Thread:

Autor: (Dein Nickname oder Nicknane des Original-Autors bei Übersetzungen)
Übersetzung: (Dein Nickname, wenn du der Übersetzer bist)
Version: (aktuelle Versionsnummer einsetzen)
Sprachversion: (Sprache des Plugins einsetzen)
Dateigröße: (Anzahl der kb oder MB und ggf. Anzahl und Art der Spieldateien, z.B.: esp, esm und/oder Omod)
Benötigt: (welche Oblivion-Version, Patches, Addons, Replacer oder weitere Plugins angeben)
Optional: (welche weiteren Plugins sind zur Ergänzung sinnvoll)
Beschreibung: (Was fügt das Plugin ins Spiel ein, was erwartet den Spieler, worauf muss er achten)
Screens: (einige kleinere Bilder zum anklicken einsetzen und mit großen Screens verlinken)
Download: (mit der Download-Seite verlinken, wo du das Plugin hochgeladen hast, wird wenn wir es hosten mit dem Portal verlinkt)
Mirror: (verlinken, z.B. mit dem engl. Original)

---

(Bitte sorgfältig ausfüllen)

Spiel: TES III - Morrowind TES IV - Oblivion TES V - Skyrim

Name des Plugins:

Version:   (z.B.: RC01 oder 1.0 oder 2.3.1)

Release-Datum: (z.B.: 05.06.2008)

Autor(en):

Download-Quelle: (bitte passenden Link eingeben)

 

Kurz-Beschreibung: (kurz und aussagekräftig das Wichtigste zum Plugin)
Sprachversion: deutsch / english Dateigröße: 12345 kb Mitwirkende: (Namen eintragen) (Beispiel: Das Plugin fügt ein Haus in Anvil mit vielen Extras und schönem Ausblick ein. Habt Spaß!)

 

Kategorie:   --- Bitte auswählen --- Häuser und Orte Kleidung und Schmuck Korrektur-Plugins Magie und Zutaten NPCs und Kreaturen Quests Ressourcen und Replacer Sonstiges Spielverbesserungen Waffen und Rüstungen

 

Abhängigkeiten:

(Mehrfachauswahl möglich)

• Morrowind

• Tribunal

• Bloodmoon

• Morrowind Goty

• Oblivion mit Patch 1.1.511 (Offizieller Patch Version 1.1)

• Oblivion mit Shivering Isles Patch 1.2.0.201 (nur mit Shivering Isles)

• Oblivion mit Patch 1.2.0.214 (Offizieller Patch Version 1.2)

• OBSE (Oblivion Script Extender)

• OBMM (Oblivion Mod Manager)

• Andere Fan-Plugins (bitte in den Details nennen und erläutern)

• Offizielle Plugins (bitte in den Details nennen und erläutern)

 

Details: (Ausführliche Erläuterungen)

 

Ort: (Wo startet das Plugin, wo befindet sich das Haus / das Item / der NPC?)

 

Installationsanleitung: (Bitte nach Bedarf ausfüllen/ergänzen oder abändern)
Das Plugin beinhaltet: - XYZ-readme.txt - XYZ.esp - XYZ.bsa - Meshes Ordner - Textures Ordner Das Archiv bitte entpacken und vollständig in den Ordner Oblivion\Data\ extrahieren (ohne die *.txt). Nach der Installation im Oblivion-Launcher unter "Spieldateien" die XYZ.esp aktivieren und das Spiel wie gewohnt starten. Zur Deinstallation bitte die oben aufgeführten Dateien manuell aus dem Data-Ordner löschen.

 

Anmerkung zur neuen Version: (Bitte nach Bedarf ausfüllen/löschen)
Wenn ihr die vorangegangene Version installiert hattet, berücksichtigt bitte Folgendes:

 

Inkompatibilität: (Bitte nach Bedarf ausfüllen/löschen)
Keine gefunden bisher. Hinweise auf Probleme sind im Release-Thread / per PN / per Mail willkommen! oder: Bei der Entwicklung sind Probleme mit folgenden Plugins bekannt geworden:

 

Bekannte Fehler oder Bugs: (Bitte nach Bedarf ausfüllen/löschen)
Keine gefunden bisher. Infos zu gefundenen Fehlern/Bugs sind im Release-Thread / per PN / per Mail willkommen! oder Bei der Entwicklung bzw. den ersten Test sind folgende Probleme bekannt geworden:

 

History / Versionsentwicklung: (Bitte nach Bedarf ausfüllen/löschen)
Version 2.0: (Beschreibung einfügen) - Version 2.0: (Beschreibung eingeben) - Version 1.0: (Beschreibung eingeben) - Beta: (Beschreibung eingeben) - RC 01: (Beschreibung eingeben)

 

Kontakt: (Bitte nach Bedarf ausfüllen/löschen)
Falls ihr euch gern bedanken oder Probleme mit diesem Plugin melden wollt, Fragen oder Hinweise habt: Ihr findet mich im Egg of Time / Ei der Zeit als 'XYZ' Ihr findet mich im offiziellen Elder Scrolls Forum als 'XYZ' Ihr findet mich auf TESNexusals 'XYZ' Ihr könnt eine Mail senden an: XYZ [AT] egg-of-time [DOT] com / XYZ [AT] ei-der-zeit [DOT] com Spam-Nachrichten werden nicht gelesen, sondern in jedem Falle sofort gelöscht.

 

Credits / Danksagungen: (Bitte nach Bedarf ausfüllen/löschen)
Mein/Unser Dank gebührt: - Bethesda für die TES-Spiele und das Construction Set - XYZ für das schöne Original-Plugin und die Permission zum Hosten und Übersetzen - XYZ für die/den schöne/n Meshes/Texturen/Sound/Sprecherarbeit/Skripte - der Ei der Zeit-Community für ihre Begeisterung, ihre geteilte Freude an unserem gemeinsamen Hobby und die permanente gegenseitige tolle Unterstützung

 

Benutzte Tools / Programme: (Bitte nach Bedarf Häkchen setzen)

• 3D Studio Max

• Blender

• BSA Commander

• CrazyBump

• DDS Converter

• DXTBmp

• ESPluginCracker

• GIMP

• GIMPShop

• Keep MipMap Details

• MaPZone

• NIFSkope

• Oblivion Face Exchange Lite

• Oblivion Mod Manager (OBMM)

• Oblivion Script Extender (OBSE)

• Paint.NET

• Paint Shop Pro

• Photoshop

• Startup Saver

• tecras Mod Translator

• TES4Dump

• TES4Edit

• TES4Files

• TES4Gecko

• Tes4plusplus

• TESAME

• TESsnip

• TES Construction Set

• TES Construction Set DV von Lady Li & Lord Sheogorath

• Texture Replacer

• The Conformulator

• UVMapper

• Wrye Bash

• ZBrush

• Ei der Zeit - Readme Generator

(Hinweis: Klickt auf die oben aufgeführten Programmnamen, um zur jeweiligen Homepage zu gelangen.)

 

Lizenz / Permission / Weiterverwendung: (Bitte nach Bedarf ausfüllen/ergänzen oder abändern)

Dieses Plugin darf nicht kostenpflichtig verbreitet werden. Die Rechte für das Spiel, alle offiziellen Plugins, Zusatzdateien und das Construction Set liegen bei Bethesda Softworks. Texturen sowie Modelle, Sound-Effekts unterliegen keinem uns bekannten Copyright einer ungenannten Partei. Das Plugin bzw. sein Inhalt darf / darf nicht weiterverwendet, verbreitet oder gehostet werden ohne die Einwilligung (Permission) des Autors. Darüber hinaus ist bei einer Verwendung (auch einzelner Teile) eine entsprechende Erwähnung in den Credits/Danksagungen erwünscht.