Awards

From EQdkp Plus
Jump to: navigation, search

tools.php?action=compare_version&repo=core&version=2.2.7&lang=de&.png tools.php?action=compare_version&repo=plugin-awards&version=0.4.0&lang=de&.png

Versionsinformationen
Core 2.2.7
Awards 0.4.0


Installation

Installiere das Award-Plugin unter Erweiterungen-Verwalten im Administrationsmenü.

Nach der Installation werden einige neue Funktionen verfügbar sein:

  • Rechte: Ansehen, Verwalten, Hinzufügen
  • Benutzereinstellungen
  • Seiten: eine Hauptseite, extra Reiter im Benutzerprofil und 2 Administrationsseiten
  • Cronjob für die automatische Zuweisung


Berechtigungen

Recht Information
Ansehen Mit diesem Recht kann der Nutzer alle Erfolge einsehen ausgenommen besondere Erfolge (welche erst nach erhalt eingesehen werden können).
Verwalten Mit diesem Recht kann der Nutzer Erfolge an andere zuweisen, er darf ebenfalls die Einstellungen zu jedem Erfolg einsehen.
Hinzufügen Mit diesem Recht kann der Nutzer alle Erfolgs Einstellungen vornehmen, neue Erfolge hinzufügen und diese auch löschen.

Darüber hinaus gibt es noch:

  • Deaktivierte Erfolge, diese zeichnen sich darin aus das diese Erfolge nicht mehr zugewiesen werden können (bereits zugewiesene bleiben erhalten).
  • Besondere Erfolge, diese werden ausgeblendet bis der betroffene Nutzer diesen Erfolg erreicht oder Administrator ist.


Benutzereinstellungen

Diese können in den Benutzereinstellungen gefunden werden und bieten folgende Möglichkeiten:

  • Award Quick Info: Dies aktiviert für den jeweiligen Nutzer im persönlichen Bereich ein `Quick Info Menü` frei, die einem zeigt welche 5 letzten Erfolge der Nutzer erhielt und alle bereits erhaltenen DKP sowie Awardpunkte(AP).
  • Layout/Template: Hiermit kann der Benutzer die Darstellung auf der Award Hauptseite(Alle Gildenerfolge) ändern.
  • Erfolge pro Seite: Hiermit kann der Benutzer festlegen ab wie vielen Erfolgen eine neue Seite angebrochen werden soll.
  • Zuweisungen/Erfolge pro Seite: Diese Einstellung ist nur für Administratoren einsehbar.


Administration

Erfolge erstellen

Um ein Erfolg erstellen zu können geht man auf Erfolge verwalten - Erfolg hinzufügen.
Nun stehen dir folgende Einstellmöglichkeiten zur Verfügung:
Name: Hier gibst du den Titel deines Erfolges an. Bsp.: Würfelkönig (Darüber hinaus besteht die Möglichkeit diesen Titel auch in andere Sprachen entsprechend zu vergeben)
Beschreibung: Hier kannst du ebenfalls für mehrere Sprachen eine Beschreibung zum Erfolg angeben. Bsp.: Würfel eine 100 im Raid.
Aktiv: (Ja/Nein) Regelt ob dieser Erfolg zugewiesen werden kann oder nicht, ist ein Erfolg nicht aktiv so können weder Administratoren noch die automatische Zuweisung diesen Erfolg zuweisen/vergeben. (Diese Einstellung kann bereits in der Hauptansicht "Erfolge verwalten" geändert werden)
Spezial: (Ja/Nein) Legt fest ob dies ein spezieller Erfolg ist, diese Zeichnen sich darin aus das sie erst dann von Nutzern gesehen werden können wenn diese bereits den Erfolg erhielten oder aber sie Administratoren sind. (Diese Einstellung kann bereits in der Hauptansicht "Erfolge verwalten" geändert werden)
AP Wert: Hier kannst du die Awardpunkte/Erfolgspunkte angeben die bei Erhalt des Erfolges den jeweiligem Charakter angerechnet weren. (AP haben keinerlei Auswirkungen auf DKP)
DKP Wert: Hier kannst du die DKP angeben die bei Erhalt des Erfolges angerechnet werden. (Dezimalzahlen sind erlaubt)
Ereignis: Um ein Erfolg richtig nutzen zu können muss er einem Event/Ereignis zugeteilt werden. Hiermit kannst du auch festlegen welchem MultiDKP-Konto die DKP angerechnet werden sollen.
Automatisch zuweisen: Die automatische Zuweisung ist ein besonderer Bestandteil der Erfolgszuweisung, hiermit kannst du anhand von Modulen angeben welche Bedingungen wie erfüllt sein müssen um das dieser Erfolg automatisch zugewiesen wird.
Icon auswählen: Hier kannst du nun noch ein gewünschtes Icon auswählen. Ist kein passendes Icon vorhanden kannst du auch dein eigenes hochladen und verwenden. Hinweis: Einige Icons sind SVGs die bieten eine erweitere Einstellmöglichkeit dar. Wählt man eines der SVGs so öffnet sich ein extra Menü auf der rechten Seite worüber man die Farben der Bildbereiche um färben kann, diese Farbeinstellungen sind dann auch sichtbar. Auch werden eigene SVGs mit dieser Funktion unterstützt, diese sollten jedoch dafür angepasst worden sein.


Erfolge zuweisen

Um einen Erfolg zuweisen zu können geht man auf Zuweisungen verwalten - Erfolg zuweisen.
Nun wählt man aus welchen Erfolg man zuweisen möchte und wählt anschließend aus welche Charaktere diesen Erfolg erhalten sollen. Das Datum ist hier natürlich ebenfalls frei wählbar.

Die automatische Zuweisung

Die automatische Zuweisung ist ein besonderer Bestandteil der Erfolgszuweisung, hiermit kannst du anhand von Modulen angeben welche Bedingungen wie erfüllt sein müssen um das dieser Erfolg automatisch zugewiesen wird. Die Einstellungen hierfür müssen in den jeweiligen Erfolgseinstellungen vorgenommen werden. Bitte beachte für eine korrekte Nutzung sollten "Benutzer" und "Charakter" Bedingungen nicht zugleich verwendet werden, da bei "Charakter" Bedingungen alle Charaktere ausgewertet werden, "Benutzer" Bedingungen hingegen wandeln alle Charaktere zu den entsprechenden Benutzern um und geben nur die Hauptcharaktere wieder. Desweiteren muss der Award-Cronjob aktiviert sein.


Weitere Infos

SVGs für Farbeinstellungen anpassen

Um deine eigenen SVG Bilder für die Farbeinstellungen anzupassen benötigt es ein paar kleinere Änderungen. Ein SVG ist Standartmäßig in etwa so aufgebaut:

<svg version="1.1" xmlns="http://www.w3.org/.......">
	<g id="Area00">
		<rect width="559.412" height="553.287"/>
	</g>
	<g id="Area01">
		<path id="Path00" style="fill-rule:evenodd;fill:#FFF;" d="M486.274 145.50......."/>
	</g>
	<g id="Area02">
		<path id="Path01" d="M486.274 145.50......." fill="#000"/>
	</g>
</svg>

Dabei ist zu beachten das keinerlei "fill:#xxx;" oder " fill="#xxx" " verwendet werden dürfen in den <path> -Tags. Desweiteren müssen die zu färben gewünschten Stellen sauber getrennt sein mithilfe der <g> -Tags. Diese sind die entsprechenden Layer (5 mögliche) welche über die Einstellungen dann gefärbt werden können.

Module

Module dienen als Bedingungen für eine automatische Zuweisung durch den Award Cronjob. Diese Module können frei angepasst werden mit dem nötigem Know-How in PHP.

Modul Aufbau

Ein Modul ist immer wie folgt aufgebaut:

  1. Einbindung der abstrakten cronmodules Klasse (cronmodules.aclass.php)
  2. Die Klasse mit dem Suffix und der cronmodules Klasse als Erbe (class *_cronmodule extends cronmodules)
  3. Die Sprachvariablen als mehrdimensionalen Array (static public $language)
  4. Die Einstellungen als mehrdimensionalen Array (protected $settings)
  5. Die Methode cron_process welche ausgeführt wird um Erfolg mit User/Member zu prüfen
  6. Die Methode display_settings für die visuelle Darstellung der Einstellungen des Moduls
<?php
if(!defined('EQDKP_INC')){
	header('HTTP/1.0 404 Not Found');exit;
}

include_once(registry::get_const('root_path').'plugins/awards/cronjob/modules/cronmodules.aclass.php');

class my_module_cronmodule extends cronmodules {
	static public $language = array(
		'german'	=> array(
			'title'			=> 'Mein Cronmodule Titel',
			'my_option'		=> 'Meine Option',
		),
		'english'	=> array(
			'title'			=> 'My cronmodule title',
			'my_option'		=> 'My Option',
		),
	);
	protected $settings = array(
		'my_option'	=> 'my_value',
	);
	
	public function cron_process($intAchID, $arrMemberIDs){
		
		return $arrMemberIDs;
	}
	
	public function display_settings($jsonSettings){
		$this->parse_settings($jsonSettings);
		
		$hash_my_option = substr(md5(__CLASS__.'my_option'), 0, 5);
		
		$htext_my_option = new htext('my_option', array('id'=>$hash_my_option, 'size' => 20, 'value' => $this->settings['my_option'] ));
		
		$htmlout = '<fieldset class="settings">
			<legend>'.$this->lang('title').'</legend>
			<dl>
				<dt><label>'.$this->lang('my_option').'</label></dt>
				<dd>'.$htext_my_option.'</dd>
			</dl>
		</fieldset>';
		
		return $htmlout;
	}
}
?>