Des librairies php pour tout mettre en case !

La documentation

Introduction

Le projet Tapcaz tel qu'il est décrit en page d'accueil :

C'est l'histoire d'un petit projet en php qui doit permettre à des développeurs PHP (professionnels ou amateurs) d'utiliser un ensemble de librairies simples et efficaces pour implémenter un moteur de type "MMORPG Web".

Ce n'est ni plus ni moins que ça : un petit projet, des librairies, et la liberté pour les développeurs d'en faire ce qu'ils souhaitent.

Développé en PHP dans le but avoué de proposer un produit de qualité professionnelle au plus grand nombre, même, et surtout, à des débutants et/ou à des amateurs (n'ayant donc pas forcément l'habitude de coder sur de gros projets).

Tout part d'un constat simple, celui que les joueurs passionnés qui souhaitent développer leur propre jeu en PHP se retrouvent souvent sans ressources spécifiques à leurs problématiques, et encore moins d'outils répondant à leurs besoins :

  • Pas de framework parce que trop gros, trop complexe à apréhender,
  • Pas de tests unitaires (manque de temps),
  • Les fonctionnalités passent devant la qualité et la maintenabilité,
  • Quand l'activité est supporté par des bénévoles, ils prennent sur leur temps libre pour s'occuper de leur jeu

Tapcaz essaye d'apporter une solution pour répondre à ces besoins et à ces problématiques. Et, bien entendu, en ayant pour objectif un code d'une qualité professionnelle, il est tout à fait adapté à une utilisation dans un contexte professionnel.

Cette documentation s'adresse donc :

  • À de futur administrateur / développeur de jeu en PHP qui veulent utiliser tapcaz, et s'éviter de fastidieuses heures de code inutiles,
  • À des débutants en programmation ayant des bases de PHP,
  • À des développeurs amateurs ou professionnels,
  • À des experts de PHP souhaitant parcourir une documentation "fonctionnelle" avant de se plonger dans la lecture du code.
  • Aux étudiants game-designer qui doivent développer rapidement des jeux pour leurs projets d'études.

Il y a principalement deux types de documentation : celle qui concerne l'API des différentes librairies (une page par librairie), et une documentation écrite comme des tutoriels pratiques, des exemples de codes, etc.

Version de la documentation

Cette documentation est celle de la version courante du projet Tapcaz, c'est à dire qu'elle est modifiée sans aucune garantie sur la rétrocompatibilité avec les précédentes versions de la documentation et du projet.

Remarque

Une url contenant les archives de la documentation sera mise à disposition dès qu'il y aura un système de version stable pour le projet Tapcaz.

Licence et droit d'auteur

La licence choisie pour le projet Tapcaz est la GNU General Public License 3. Vous pouvez donc librement utiliser le code source : la seule restriction est lors de la diffusion à des tiers du code produit grâce à tapcaz.

C'est un choix important qui a été fait : tapcaz doit permettre à quiconque de l'utiliser, et si quelqu'un souhaite diffuser ses modifications, ses ajouts, il faut que cela ce fasse avec une licence libre compatible.

Le contenu du site de Tapcaz.fr (textes et images), est quant à lui disponible sous la licence CC 3.0 By-Nc-Sa.

Installation

L'installation de tapcaz est simple : il suffit de mettre le répertoire "Tapcaz" à la racine d'un répertoire de l'include path, puis d'utiliser l'autoload de Tapcaz.

Exemple

// On considère que "Tapcaz" est dans l'include_path de php
// Par exemple : /usr/share/php/Tapcaz

// Inclure la classe d'autoload

require 'Tapcaz/Autoload.php';
Tapcaz_Autoload::configure();

// Utilisation des classes de Tapcaz

$tileFactory = new Tapcaz_Map_Tile_Simple_Factory();
$map = new Tapcaz_Map(10, 10, $tileFactory, array());

Ressources et tutoriels

Plus d'informations à venir prochainement.

Foire aux questions

Posez vos questions, elles seront déposées ici avec les réponses correspondantes si cela peut servir à d'autres.