Supported Foundry Version Badge
This badge provides a simple way to display which version (or versions) of FoundryVTT core your System, Module or World supports. All you need is a link to the manifest file!
Choose what you are generating a badge for:
For Systems
For systems that are built for FoundryVTT version 10 or later this badge checks the values of compatibility.minimum, compatibility.verified and compatibility.maximum in the system.json file. If all three are the same or just the minimum value is defined, one supported version will be shown. Otherwise, the range between the minimum and the verified or maximum versions will be shown. If both the verified and maximum versions are present the verified value is used.
For systems that are built for FoundryVTT versions before 10 this badge checks the values of minimumCoreVersion and compatibleCoreVersion in the system.json file. If they are the same or one is missing, one supported version will be shown. Otherwise, the range between the two supported versions will be shown.
If the values for version 10 or later and before version 10 are present in the system.json the version 10 or later values will be used.
For details about setting up a FoundryVTT system check out the system documentation. For details on how FoundryVTT does its versioning check the versioning documentation.
Options
The following styles are available for customizing your badge. Flat is the default. Examples are shown with an optional logo:
Examples
When your system only supports one version of FoundryVTT (both the minimumCoreVersion and compatibleCoreVersion are the same)
https://img.shields.io/endpoint?url=https://foundryshields.com/version?url=https://foundryshields.com/assets/examples/module-system-single-version.jsonWhen your system supports a range of versions of FoundryVTT (the minimumCoreVersion and compatibleCoreVersion are different)
https://img.shields.io/endpoint?url=https://foundryshields.com/version?url=https://foundryshields.com/assets/examples/module-system-version-range.jsonCreate Your Own Badge!
Be sure to link from the raw view of the file to ensure it can be processed properly!
Here is a preview of and link to your Supported Version Badge!
For Modules
For modules that are built for FoundryVTT version 10 or later this badge checks the values of compatibility.minimum, compatibility.verified and compatibility.maximum in the module.json file. If all three are the same or just the minimum value is defined, one supported version will be shown. Otherwise, the range between the minimum and the verified or maximum versions will be shown. If both the verified and maximum versions are present the verified value is used.
For modules that are built for FoundryVTT versions before 10 this badge checks the values of minimumCoreVersion and compatibleCoreVersion in the module.json file. If they are the same or one is missing, one supported version will be shown. Otherwise, the range between the two supported versions will be shown.
If the values for version 10 or later and before version 10 are present in the module.json the version 10 or later values will be used.
For details about setting up a FoundryVTT module check out the module documentation. For details on how FoundryVTT does its versioning check the versioning documentation.
Options
The following styles are available for customizing your badge. Flat is the default. Examples are shown with an optional logo:
Examples
When your module only supports one version of FoundryVTT (both the minimumCoreVersion and compatibleCoreVersion are the same)
https://img.shields.io/endpoint?url=https://foundryshields.com/version?url=https://foundryshields.com/assets/examples/module-system-single-version.jsonWhen your module supports a range of versions of FoundryVTT (the minimumCoreVersion and compatibleCoreVersion are different)
https://img.shields.io/endpoint?url=https://foundryshields.com/version?url=https://foundryshields.com/assets/examples/module-system-version-range.jsonCreate Your Own Badge!
Be sure to link from the raw view of the file to ensure it can be processed properly!
Here is a preview of and link to your Supported Version Badge!
For Worlds
For worlds that are built for FoundryVTT version 10 or later this badge checks the values of compatibility.minimum, compatibility.verified and compatibility.maximum in the world.json file. If all three are the same or just the minimum value is defined, one supported version will be shown. Otherwise, the range between the minimum and the verified or maximum versions will be shown. If both the verified and maximum versions are present the verified value is used.
For worlds that are built for FoundryVTT versions before 10 this badge checks the value of coreVersion in the world.json file and will show the supported FoundryVTT version.
If the values for version 10 or later and before version 10 are present in the world.json the version 10 or later values will be used.
For details on how FoundryVTT does its versioning check the versioning documentation.
Options
The following styles are available for customizing your badge. Flat is the default. Examples are shown with an optional logo:
Examples
https://img.shields.io/endpoint?url=https://foundryshields.com/version?url=https://foundryshields.com/assets/examples/world.jsonCreate Your Own Badge!
Be sure to link from the raw view of the file to ensure it can be processed properly!
Here is a preview of and link to your Supported Version Badge!
Supported Game System
This badge provides a simple way to display which FoundryVTT game system(s) your module or world is built for. All you need is a link to the manifest file!
Details
For modules or worlds that are built for Foundry VTT version 10 or later this badge checks the value of relationships.systems in the Foundry module.json or world.json file.
For modules or worlds that are built for Foundry VTT versions before 10 this badge will check the value of systems or system in the Foundry module.json or world.json file.
For details about specifying specific systems for a module check out the module documentation.
Options
The following styles are available for customizing your badge. Flat is the default. Examples are shown with an optional logo:
You can also specify how the name of the system is displayed. This only works for the top used game systems in Foundry. You can choose from:
- Full: The full name of the Game System that could be found eg.
Pathfinder 2nd Edition - Foundry: The full name of the Game System as set in FoundryVTT's System list eg.
Pathfinder 2e - Short: The shorthand for the Game System eg.
PF2e - Raw: How the system names itself in code eg.
pf2e
You can also choose to include the version of the system that is required for the module/world:
- For modules and worlds build for Foundry VTT version 10 or later this checks the
compatibilityproperty of each listed system in therelationships.systemsproperty in the module.json or world.json file. - For modules built for Foundry VTT versions before 10 this checks the
minimumSystemVersionproperty of the module.json file. - For worlds built for Foundry VTT versions before 10 this checks the
systemVersionproperty of the world.json file.
Examples
Different game system name displays
https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fsystem%3FnameType%3Dfull%26url%3Dhttps%3A%2F%2Ffoundryshields.com%2Fassets%2Fexamples%2Fworld.json
https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fsystem%3FnameType%3Dshort%26url%3Dhttps%3A%2F%2Ffoundryshields.com%2Fassets%2Fexamples%2Fworld.jsonA world that requires a specific version of the system
https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fsystem%3FnameType%3Dshort%26showVersion%3D1%26url%3Dhttps%3A%2F%2Ffoundryshields.com%2Fassets%2Fexamples%2Fworld.jsonA module that does require any specific game systems
https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fsystem%3FnameType%3Dshort%26style%3Dflat%26url%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fvigoren%2Ffoundryvtt-simple-calendar%2Fmain%2Fsrc%2Fmodule.jsonCreate Your Own Badge!
Be sure to link from the raw view of the file to ensure it can be processed properly!
Here is a preview of and link to your Supported Game Systems Badge!