La clef API est disponible dans la fenêtre “Options” du personnage. Elle est constituée d'une chaîne de 40 caractères hexadécimaux.

Cette clef permet de se connecter au jeu, et doit donc rester secrète.

Une fois connecté au jeu pour un perso donné, si vous voulez accéder aux fonctions API pour un autre perso vous devez changer de perso ou vous déconnecter via l'interface du jeu. Le système de connexion du flux API ne tente de vous connecter que si vous êtes déconnecté.

La seule fonction disponible à ce jour est la fonction de visualisation : getinfos.php

On y accède à l'adresse http://www.starshine-online.com/getinfos.php?login=[login]&key=[clef_api]&parametres_de_tri

Ou plus simplement http://www.starshine-online.com/getinfos.php?parametres_de_tri si vous êtes déjà connecté au jeu.

Les paramètres permettant de trier :

• cache_moi : Cache mon perso (si le paramètre est présent)
• cache_autre_perso : Cache les autres persos (si le paramètre est présent)
• cache_pnj : Cache les PNJs (si le paramètre est présent)
• cache_monstre : Cache les monstres (si le paramètre est présent)
• cache_batiment_en_construction : Cache les bâtiments en construction (drapeaux, bâtiments, murs, armes de siège) (si le paramètre est présent)
• cache_batiment : Cache les bâtiments construits (bâtiments, murs, armes de siège) (si le paramètre est présent)
• xsl : Définit l'url d'une feuille XSL qui sera attachée au fichier XML (xsl=URL), aucune feuille XSL par défaut

La structure du fichier XML avec une balise de chaque et le nom des attributs :

<infos radius building_radius timezone>
	<square x y decor royaume type type_terrain>
		<pc nom race classe level exp honneur reputation frag mort crime melee distance esquive blocage dressage artisanat survie incantation sort_vie sort_element sort_mort image est_mort />
		<npc nom image />
		<building type nom royaume hp hp_max image />
		<construction type nom royaume hp hp_max debut_placement fin_placement image />
		<monster nom lib />
	</square>
</infos>

• <infos> est la racine du document XML et contient des informations générales sur la zone de visualisation de la carte. Les cases visibles vérifient 'radius' ou 'building_radius'.
  • radius : Distance de Tchebychev visible autour la case du personnage.
  • building_radius : Distance euclidienne visible autour de la case du personnage. Bonus de vision le plus grand fournit par un des bâtiments sur la case du personnage, par exemple un bâtiment de type 'tour'.
  • timezone : Fuseau horaire utilisé par PHP pour toutes les fonctions date/heure. Utile pour utiliser les timestamps donnés par le document XML. Liste des Fuseaux Horaires Supportés
• <square> représente une case de la carte du jeu.
  • x : Abscisse de la case.
  • y : Ordonnée de la case.
  • decor : Identifiant numérique utilisé dans le fichier css/texture.css du jeu pour définir l'image de la case.
  • royaume : Identifiant numérique du royaume d'appartenance de la case. Détails sur les royaumes
  • type : 0=rien, 1=case_de_ville, 2=?, 3=point_exceptionnel, à partir de 4 ça représente le calque utilisé par-dessus le décor (voir la table 'map_type_calque' dans la BDD).
  • type_terrain : Identifiant textuel utilisé par le jeu pour définir le terrain de la case. Détails sur les types de terrain
• <pc> représente un personnage joueur du jeu.
  • nom : Nom du personnage.
  • race : Race du personnage sous la même forme que le champ 'race' des royaumes. Détails sur les royaumes
  • classe : Classe du personnage. (Uniquement si on a le droit de voir sa classe.)
  • level : Niveau du personnage. (Uniquement si on a le droit de voir son niveau.)
  • exp : Expérience du personnage. (Uniquement si on a le droit de voir son niveau.)
  • honneur : Honneur du personnage. (Uniquement si on a le droit de voir ses stats.)
  • reputation : Réputation. (… stats)
  • frag : Nombre de personnages tués. (… stats)
  • mort : Nombre de fois où le personnage est mort. (… stats)
  • crime : Nombre de points de crime. (… stats)
  • melee : Mêlée. (… stats)
  • distance : Tir à distance. (… stats)
  • esquive : Esquive. (… stats)
  • blocage : Blocage. (… stats)
  • dressage : Dressage. (… stats)
  • artisanat : Artisanat. (… stats)
  • survie : Survie. (… stats)
  • incantation : Incantation. (… stats)
  • sort_vie : Magie de la vie. (… stats)
  • sort_element : Magie élémentaire. (… stats)
  • sort_mort : Nécromancie. (… stats)
  • image : Identifiant d'image utilisé pour afficher le personnage dans le jeu. (Varie en fonction du personnage qui regarde)
  • est_mort : Définit si le personnage est mort ou non. Peut prendre la valeur 'true' ou 'false'.
• <npc> représente un personnage non joueur du jeu.
  • nom : Nom du PNJ.
  • image : Identifiant d'image utilisé pour afficher le PNJ dans le jeu.
• <building> représente un bâtiment, une arme de siège ou un mur construit.
  • type : Différents types de bâtiments à l'heure actuelle : 'arme_de_siege', 'mur', 'mine', 'bourg', 'fort', 'tour'. Détails sur les bâtiments
  • nom : Nom du bâtiment
  • royaume : Identifiant numérique du royaume du bâtiment. Détails sur les royaumes
  • hp : Points de vie actuels du bâtiment.
  • hp_max : Points de vie maximum du bâtiment.
  • image : Identifiant d'image utilisé pour afficher le bâtiment dans le jeu.
• <construction> représente un drapeau, un bâtiment, une arme de siège ou un mur en cours de construction.
  • type : Différents types de bâtiments en construction à l'heure actuelle : 'drapeau', 'arme_de_siege', 'mur', 'mine', 'bourg', 'fort', 'tour'. Détails sur les bâtiments
  • nom : Nom de la construction.
  • royaume : Identifiant numérique du royaume de la construction. Détails sur les royaumes
  • hp : Points de vie actuels de la construction.
  • hp_max : Points de vie maximum de la construction.
  • debut_placement : Timestamp du début de la construction.
  • fin_placement : Timestamp de la fin de la construction.
  • image : Identifiant d'image utilisé pour afficher la construction dans le jeu.
• <monster> représente un monstre du jeu.
  • nom : Nom du monstre.
  • lib : Identifiant utilisé pour je ne sais pas encore quoi.

Tableau des royaumes

Remarques :

• Le royaume d'identifiant 0 (royaume Neutre) n'est pas vraiment un royaume.
• Le royaume d'identifiant 5 n'existe pas.
• Pour mettre à jour le tableau, voir la table 'royaume' dans la BDD.

Tableau des types de terrain

Remarques :

• La colonne “Tentative d'interprétation” essaye de donner un sens à l'identifiant textuel mais tout n'est pas certain surtout vers la fin. :D
• Pour mettre à jour le tableau, voir le fichier fonction/base.inc.php --> fonction type_terrain().

Tableau des bâtiments

Remarques :

• Les drapeaux ne peuvent être que des bâtiments en construction car une fois la construction terminée ils disparaissent en modifiant le royaume d'appartenance de la case sur laquelle ils se trouvaient.
• Pour mettre à jour le tableau, voir la table 'batiment' dans la BDD.