Project Intelligence Mod pour Minecraft 1.12.2, 1.16.5

Bienvenue dans Project Intelligence ! alias "PI"

L'objectif de ce projet est de créer un mod de documentation véritablement universel en tirant parti de la puissance de la communauté Minecraft.

Alors, comment cela va-t-il fonctionner ? Pour commencer, n'importe quel développeur de mod peut ajouter de la documentation pour son mod à PI. Le problème, c'est que les développeurs de mods sont des gens occupés, donc la plupart n'auront pas le temps d'écrire de la documentation pour un mod de documentation quelconque comme PI, et à mon avis, c'est un problème majeur avec la plupart des mods de documentation actuels. Ils doivent être directement pris en charge par les moddeurs. PI vise à résoudre ce problème en permettant à n'importe qui dans la communauté de contribuer en écrivant de la documentation pour divers mods à l'aide de l'éditeur intégré relativement simple. Ils peuvent ensuite soumettre leur documentation via une pull request et, si elle passe la révision, elle sera ajoutée au dépôt en ligne.

Tout ce que fait PI est open source et complètement transparent. Toute la documentation est stockée sous sa forme brute sur github. Elle est ensuite compilée par un serveur jenkins et téléversée vers un serveur web contrôlé par covers1624, où elle peut être consultée par PI. Tout ce que PI utilise provient de ce serveur, y compris toutes les images utilisées dans la documentation. Aucune requête n'est faite vers des serveurs en dehors de pi.brandon3055.com. La seule exception possible concerne la documentation de pack, dont vous pouvez en savoir plus ci-dessous.

Edit : la déclaration ci-dessus sera vraie une fois que covers aura terminé pi bot, qui garantira automatiquement que toutes les images utilisées dans pi sont hébergées sur notre serveur. D'ici là, certaines documentations peuvent contenir des images hébergées sur imgur.com ou un autre site d'hébergement de ce type.

Fonctionnalités : (cette liste devrait s'allonger au fur et à mesure du développement de PI)

Interface utilisateur hautement personnalisable Toute l'interface utilisateur de PI est hautement personnalisable par l'utilisateur. PI ne dispose actuellement que de 2 préréglages de style par défaut, mais d'autres seront ajoutés à l'avenir. Et les utilisateurs ont la possibilité d'enregistrer leurs propres préréglages personnalisés. Note annexe : si vous avez créé un préréglage que vous pensez qui ferait un bon ajout aux préréglages par défaut, n'hésitez pas à le publier sur github.

Intégration JEI PI dispose d'une prise en charge complète des recettes JEI, ce qui signifie que toute recette prise en charge par JEI peut être affichée dans la documentation PI.

Liaison de contenu et "Explain This" Cela vous permet de lier des objets, des blocs ou des entités à des pages de documentation. Cela fonctionne avec une fonctionnalité appelée "Explain This" qui vous permet d'ouvrir les pages de documentation liées en appuyant simplement sur une touche de raccourci en regardant un objet dans le monde ou en survolant votre souris sur un objet dans un inventaire.

Lier la documentation aux Gui's Cette fonctionnalité nécessite actuellement que les mods la prennent en charge (bien que cela puisse changer à l'avenir) Cette fonctionnalité permet aux développeurs de mods de lier des pages de documentation spécifiques aux gui's de leur mod. Pi ajoutera alors un bouton "info" aux gui's prises en charge, qui ouvrira une mini fenêtre pi à l'intérieur du gui contenant les pages liées au gui.

Prise en charge de la localisation linguistique

Éditeur intégré L'éditeur de doc pi a encore besoin de travail, mais tel qu'il est actuellement, l'éditeur fournit toutes les fonctionnalités de base nécessaires pour écrire et maintenir de la documentation.

Prise en charge de plusieurs versions de mods C'est une fonctionnalité essentielle lorsqu'on écrit de la documentation pour des mods en constante évolution. Cette fonctionnalité vous permet de mettre à jour votre documentation lorsqu'un mod change quelque chose sans casser la compatibilité avec les versions précédentes du mod.

Doc de pack Il s'agit d'une fonctionnalité ajoutée pour les développeurs de mod packs. Elle vous permet d'écrire une documentation identique à la documentation de mod, sauf qu'elle n'est pas liée à un mod spécifique et qu'elle est stockée localement dans la config du pack, ce qui signifie qu'elle peut être livrée avec le mod pack. Il est à noter que, contrairement à la documentation de mod, je n'ai aucun contrôle sur l'hébergement des images utilisées dans la documentation de pack. Il appartient au développeur du pack de les héberger sur un site comme imgur.com ou sur son propre serveur privé d'hébergement d'images.

Contribution : vous pouvez trouver toutes les informations dont vous avez besoin concernant la contribution dans la documentation en jeu de PI elle-même.

Veuillez noter que le système back end qui rendra possible la gestion facile de la documentation contribuée par les utilisateurs est encore en cours de développement par covers1624. J'ai la capacité d'accepter manuellement de la documentation, mais je recommande d'attendre que covers ait terminé le back end.

Edit : après réflexion, covers est un peu occupé avec d'autres projets, donc pour le moment cela devra rester un processus manuel.