Difference between revisions of "Mods repository"

From VCMI Project Wiki
Jump to: navigation, search
m (Suggested solution)
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
= Problems =
+
This article will introduce you to new VCMI mod repository system and explain how new mods can be added there.
  
Current mod distribution model will eventually face following problems:
+
= How mod repository work =
  
* Lack of changes tracking repository and mods. It's not big deal now, but once we have scripting that will be very important especially if that would be Python or any other language where secure sandboxing is not possible.
+
== Where files are hosted ==
* Forward compatibility / backward compatibility. When we start to add new features newer versions of mods won't work in older versions of game. So at least we need to maintain two version of mods index: current stable and develop.
 
* We need a way to let other contributors to help us with mod maintenance and testing.
 
  
= Suggested solution =
+
Mods list hosted under main VCMI organization: [https://github.com/vcmi/vcmi-mods-repository vcmi-mods-repository].
  
Mods index JSON hosted in git. Main branch "develop" and there will be branching into 1.00, 1.01 or whatever once they released.
+
Each mod hosted in it's own repository under separate organization [https://github.com/vcmi-mods vcmi-mods]. This way if engine become more popular in future we can create separate teams for each mod and accept as many people as needed.
  
Launcher should request specific version of JSON index from our server:
+
== Why Git / GitHub? ==
<pre>
+
 
https://repository.vcmi.download/develop.json
+
It's solve a lot of problems:
https://repository.vcmi.download/0.99.json
+
 
https://repository.vcmi.download/0.98.json
+
* Engine developers get control over all mods and can easily update them without adding extra burden for modders / mod maintainers.
</pre>
+
* With tools such as [https://desktop.github.com/ GitHub Desktop] it's easy for non-programmers to contribute.
 +
* Forward and backward compatibility. Stable releases of game use compatible version of mods while users of daily builds will be able to test mods supporting bleeding edge features.
 +
* Tracking of changes for repository and mods. It's not big deal now, but once we have scripting it's will be important to keep control over what code included in mods.
 +
* GitHub also create ZIP archives for us so mods will be stored uncompressed and version can be identified by commit hash.
 +
 
 +
== On backward compatibility ==
 +
 
 +
Our mod list in vcmi-mods-repository had "develop" as primary branch. Daily builds of VCMI use mod list file from this branch.
 +
 
 +
Once VCMI get stable release there will be branching into "1.0.0", "1.1.0", etc. Launcher of released version will request mod list for particular version.
 +
 
 +
Same way we can also create special stable branch for every mod under "vcmi-mods" organization umbrella once new stable version is released. So this way it's will be easier to maintain two versions of same mod: for stable and latest version.
 +
 
 +
= Getting mod into repository =
  
== Mods hosting ==
+
== Getting into vcmi-mods organization ==
All mods hosted in separate repositories on GitHub under separate "vcmi-mods" organization:
 
  
  https://github.com/vcmi-mods/adventure-ai-trace
+
Before your mod can be accepted into official mod list you need to get it into repository under "vcmi-mods" organization umbrella. To do this contact one of mod repository maintainers. If needed you can get own team within "vcmi-mods" organization.
  
Trusted community members who can't help with programming can now help us to maintain mods.
+
Link to our mod will looks like that:
  
== Mods update submission ==
 
Once mod updated by creator he or maintainer able to make PR to index JSON. All that needed to be provided is commit hash from appropriate branch. In the end our mod repository will only contain link like that:
 
 
<pre>
 
<pre>
https://mods.vcmi.download/adventure-ai-trace/821190ef5396702bf763c764ed532781b1fc1ce6.zip
+
https://github.com/vcmi-mods/adventure-ai-trace
 
</pre>
 
</pre>
Since archive will be auto-generated by GitHub from commit that also provide us with somewhat secure.
 
  
== Redirect server ==
+
== Rules of repository ==
  
That server just going to be redirect Launcher to proper download link like:
+
=== Allowed name for mod identifier ===
 +
For sanity reasons mod identifier must only contain lower-case English characters, numbers and hyphens.
 
<pre>
 
<pre>
https://repository.vcmi.download/develop.json -> https://raw.githubusercontent.com/vcmi/mods-repository/develop/repository.json
+
my-mod-name
https://repository.vcmi.download/0.99.json -> https://raw.githubusercontent.com/vcmi/mods-repository/0.99/repository.json
+
2000-new-maps
https://mods.vcmi.download/adventure-ai-trace/821190ef5396702bf763c764ed532781b1fc1ce6.zip -> https://github.com/vcmi-mods/adventure-ai-trace/archive/821190ef5396702bf763c764ed532781b1fc1ce6.zip
 
 
</pre>
 
</pre>
So far I hope that logic can be implemented in Jekyll and hosted on GitHub Pages, but if not then we'll have something super-lightweight in Nginx Lua.
+
Sub-mods can be named as you like, but we strongly encourage everyone to use proper identifiers for them as well.
 +
 
 +
=== Rewriting History ===
  
== Ideas and possible problems ==
+
Once you submitted certain commit into official mod list you are not allowed to rewrite history before that commit. This way we can make sure that VCMI launcher will always be able to download older version of any mod.
There are few and likely others will appear:
 
  
* Would be great to split repository JSON into multiple small files. Sadly doubt they can be merged with Jekyll.
+
Branches such as "develop" or stable branches like "1.0.0" should be marked as protected on GitHub.
* GitHub might change how ZIP created and that would change archives checksums. So if we want additional checksums over just commit hash then we need implement them different way.
 
* We should decide what organization should own mods repository (JSON) and who should be able to commit into it.
 
  
= Short FAQ =
+
== Submitting mods to repository ==
  
====What about assets licensing issues?====
+
Once mod ready for general public maintainer to make PR to [https://github.com/vcmi/vcmi-mods-repository vcmi-mods-repository].
First of all it's only problem with some mods and they all pretty much fair use or at least not any worse than any other mod for other game. Just in case it's still better to keep them in separate organization and own repository. In worst case we'll need to host data of some particular mod separately.
 
  
====What if GitHub become less generous?====
+
== Requirements ==
It's totally possible that eventually GitHub might forbid direct RAW / ZIP access, but so far there is great amount of far more popular projects using it and VCMI unlikely ever become popular enough to reach any limits.
 
  
Even if that happen we could rapidly redirect downloads to competing services such as GitLab / BitBucket by simply keeping repository clones there. In same time infrastructure could always be on GitHub.
+
Right now main requirements for a mod to be accepted into VCMI mods list are:
  
====WTF is vcmi.download?====
+
* Mod must be complete. For work-in-progress mods it is better to use other way of distribution.
That is my domain that I registered and pre-paid until end of 2026. I think it's smart to keep any gray area files outside of our main domain.
+
* Mod must met some basic quality requirements. Having high-quality content is always preferable.
 +
* Mod must not contain any errors detectable by validation (console message you may see during loading)
 +
* Music files must be in Ogg/Vorbis format (*.ogg extension)

Latest revision as of 10:56, 16 September 2022

This article will introduce you to new VCMI mod repository system and explain how new mods can be added there.

How mod repository work

Where files are hosted

Mods list hosted under main VCMI organization: vcmi-mods-repository.

Each mod hosted in it's own repository under separate organization vcmi-mods. This way if engine become more popular in future we can create separate teams for each mod and accept as many people as needed.

Why Git / GitHub?

It's solve a lot of problems:

  • Engine developers get control over all mods and can easily update them without adding extra burden for modders / mod maintainers.
  • With tools such as GitHub Desktop it's easy for non-programmers to contribute.
  • Forward and backward compatibility. Stable releases of game use compatible version of mods while users of daily builds will be able to test mods supporting bleeding edge features.
  • Tracking of changes for repository and mods. It's not big deal now, but once we have scripting it's will be important to keep control over what code included in mods.
  • GitHub also create ZIP archives for us so mods will be stored uncompressed and version can be identified by commit hash.

On backward compatibility

Our mod list in vcmi-mods-repository had "develop" as primary branch. Daily builds of VCMI use mod list file from this branch.

Once VCMI get stable release there will be branching into "1.0.0", "1.1.0", etc. Launcher of released version will request mod list for particular version.

Same way we can also create special stable branch for every mod under "vcmi-mods" organization umbrella once new stable version is released. So this way it's will be easier to maintain two versions of same mod: for stable and latest version.

Getting mod into repository

Getting into vcmi-mods organization

Before your mod can be accepted into official mod list you need to get it into repository under "vcmi-mods" organization umbrella. To do this contact one of mod repository maintainers. If needed you can get own team within "vcmi-mods" organization.

Link to our mod will looks like that:

https://github.com/vcmi-mods/adventure-ai-trace

Rules of repository

Allowed name for mod identifier

For sanity reasons mod identifier must only contain lower-case English characters, numbers and hyphens.

my-mod-name
2000-new-maps

Sub-mods can be named as you like, but we strongly encourage everyone to use proper identifiers for them as well.

Rewriting History

Once you submitted certain commit into official mod list you are not allowed to rewrite history before that commit. This way we can make sure that VCMI launcher will always be able to download older version of any mod.

Branches such as "develop" or stable branches like "1.0.0" should be marked as protected on GitHub.

Submitting mods to repository

Once mod ready for general public maintainer to make PR to vcmi-mods-repository.

Requirements

Right now main requirements for a mod to be accepted into VCMI mods list are:

  • Mod must be complete. For work-in-progress mods it is better to use other way of distribution.
  • Mod must met some basic quality requirements. Having high-quality content is always preferable.
  • Mod must not contain any errors detectable by validation (console message you may see during loading)
  • Music files must be in Ogg/Vorbis format (*.ogg extension)