Skip to content

Adding metadata for mod

ALIENQuake edited this page May 23, 2021 · 35 revisions

How to add metadata for the mod:

  1. Inside the same folder where the *.tp2 file is located create a file called: TheNameOfYouTp2File.ini, use "UTF8 without BOM" encoding.
  2. Copy and paste everything below then edit accordingly.
# Never copy this from other mod, always use https://github.com/ALIENQuake/ProjectInfinity/wiki/Adding-metadata-for-mod
# Filename must be the same as tp2 basename, placed at the same folder where
# .tp2 file is located, use UTF8 (without BOM) encoding, everything is optional

# ini section header is required to avoid false detection
[Metadata]

# Full name of the mod, without the version number, without the list of supported games
Name = Mod Example - Optional Features

# Author name or nick, don't use an email address
Author = AL|EN

# Short description of the mod, main goals, features etc
Description = This mod is a guide on how to use optional 'Project Infinity' features.

# Web address of mod readme file (filename is case-sensitive!) You can link to txt, md, html, pdf etc.
Readme = https://example.com/ModName-Readme.html, https://example.com/ModName-Readme-%LANGUAGE%.html

# Web address of mod dedicated forum or forum thread 
Forum = https://www.example.com/forums/categories/forum thread

# Web address of mod personal Homepage, no need to duplicate with a mod dedicated forum
# Homepage = https://www.example.com

# if you use GitHub.com, simply use https://github.com/AccountOrOrgName/RepositoryName
# read more about Delta Updates https://github.com/ALIENQuake/ProjectInfinity/wiki/Delta-Updates-for-mods-hosted-at-Github
Download = https://github.com/AccountOrOrgName/ModExample-OptionalFeatures

# Type of LABELs used by the mod, read more here https://www.gibberlings3.net/forums/topic/32516-tutorial-what-is-label
LabelType = GloballyUnique

# Dynamic Install Order, use mod ID as tp2 name without file extension and `setup-` prefix

# This mod must be installed *before* the mods listed after the keyword
Before = EET_end

# This mod must be installed *after* the mods listed after the keyword
After = EET

Example presentation:

Real mod examples:
https://github.com/InfinityMods/LongerRoadEE/blob/master/LongerRoadEE/LongerRoadEE.ini

Clone this wiki locally