Skip to content

ModLinks: add ReadMe element #2683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SFGrenade wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −1
Open

ModLinks: add ReadMe element #2683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8928cc
ModLinks: add `ReadMe` element
SFGrenade Jul 16, 2026
cb8c737
ReadMe: adjust example manifest
SFGrenade Jul 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,13 @@ If you are familiar with common Git and GitHub workflows, this approach may be m
<Repository>
<![CDATA[https://github.com/user/repo]]>
</Repository>
<!-- OPTIONAL: where can the contents of the readme be directly read from? -->
<ReadMe>
<![CDATA[https://github.com/user/repo/raw/refs/heads/main/ReadMe.md]]>
</ReadMe>
<!-- OPTIONAL: where should issues with the mod be reported? -->
<Issues>
<![CDATA[https://website/for/bug_reports]]>
<![CDATA[https://github.com/user/repo/issues]]>
</Issues>
<!-- OPTIONAL: Optional dependencies can be listed here. For when the mod has special interactions with other mods. Here are some examples -->
<Integrations>
Expand Down
1 change: 1 addition & 0 deletions Schemas/ModLinks.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
</xs:choice>
<xs:element minOccurs="1" maxOccurs="1" name="Dependencies" type="mm:DepListType" />
<xs:element minOccurs="1" maxOccurs="1" name="Repository" type="mm:LinkStringType" />
<xs:element minOccurs="0" maxOccurs="1" name="ReadMe" type="mm:LinkStringType" />
<xs:element minOccurs="0" maxOccurs="1" name="Issues" type="mm:LinkStringType" />
<xs:element minOccurs="0" maxOccurs="1" name="Integrations" type="mm:IntegrationListType" />
<xs:element minOccurs="0" maxOccurs="1" name="Tags" type="mm:TagListType" />
Expand Down
Loading