Project Intelligence
Welcome to Project Intelligence, also known as "PI"!
The main goal of this project is to create a truly universal documentation mod using the capabilities of the Minecraft community.
How does it work? Any mod developer can add documentation for their mod to PI. However, developers are often busy and don't always have time to write documentation. This is exactly the problem that PI solves - now any community member can contribute by creating documentation for various mods using the built-in editor. After review, materials are added to the online repository.
All PI functionality is open and completely transparent. All documentation is stored in its original form on GitHub, compiled by a Jenkins server and uploaded to a web server from where it is available to PI. All used images are also hosted on this server. The exception is documentation for modpacks, which is described in more detail below.
Main Features:
Customizable Interface
The PI interface is fully customizable for the user. Several default styles are available, as well as the ability to create your own presets.
JEI Integration
PI fully supports JEI recipes, allowing them to be displayed in documentation.
Content Linking and "Explain This" Function
You can link items, blocks, or entities to documentation pages. The "Explain This" function allows you to open linked pages by pressing a key combination while looking at an object in the world or hovering over an item in an inventory.
Linking Documentation to Interfaces
Mod developers can link documentation pages to their mod interfaces. PI will add an "Info" button to supported interfaces, opening a window with relevant documentation.
Localization Support
Full support for translation into different languages.
Built-in Editor
The editor provides all necessary functions for creating and editing documentation.
Support for Multiple Mod Versions
An important feature for documentation of constantly updated mods. Allows updating materials without losing compatibility with previous versions.
Documentation for Modpacks
A special feature for modpack developers. Allows creating documentation similar to mod documentation, but not tied to a specific mod and stored locally in pack configurations. Unlike mod documentation, images for modpacks are hosted by developers themselves.
Contributing:
All necessary information for contributing to PI documentation is available in the game itself. Currently, the process of adding materials is done manually.
