Repository re-organization, cleanup and add-on management, using Git history

README.md

@@ -1,15 +1,25 @@
-SuperTux Addon
+SuperTux Addons
 ==============
 
+## Packaging your addon
+
+To package your addon, you can use the "Package Add-on" option in the main level editor menu.
+
+<details>
+<summary>Additional information for addon .nfo files</summary>
+<br>
 Addon .nfo files look like this:
 
-    (supertux-addoninfo
-      (id "octo-levels")
-      (version 1)
-      (type "worldmap")
-      (title "Octo's Levels")
-      (author "Octo")
-      (license "GPL 2+ / CC-by-sa 3.0"))
+```
+(supertux-addoninfo
+  (id "octo-levels")
+  (version 1)
+  (type "worldmap")
+  (title "Octo's Levels")
+  (author "Octo")
+  (license "GPL 2+ / CC-by-sa 3.0")
+)
+```
 
 The `id` is a identifier for this addon, it has to be unique across
 all addons, as it is used to compare the addons with new ones from
@@ -28,4 +38,31 @@ the addon is handled.
 
 The .nfo file itself needs to be stored in the top-level directory of
 the addon and should be named by the unique id of the addon, i.e.
-"/octo-levels.nfo" in this example.
+`/octo-levels.nfo` in this example.
+</details>
+
+## Adding/Updating an addon
+To update an addon in the repository, you would need to submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
+The pull request should contain two commits:
+
+1. Adds/replaces the archive of your addon, contained in the `repository/` directory with a new one, which contains your changes.
+2. Edits the `index.nfo` for the latest SuperTux version, by adding/modifying the entry for your addon. This will allow it to be downloaded from the in-game addon manager.
+
+An addon data entry looks like this:
+
+<pre>
+(supertux-addoninfo
+    (id "<b>addon-id</b>")
+    (version <b>addon-version</b>)
+    (type <b>addon-type</b>)
+    (title "<b>addon-title</b>")
+    (author "<b>addon-author</b>")
+    (license "<b>addon-license</b>")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/<b>addon-commit-hash</b>/repository/<b>addon-file-name</b>")
+    (md5 "<b>addon-md5-checksum</b>")
+)
+</pre>
+
+* **addon-commit-hash** represents the full commit hash of your first commit, which adds/replaces your addon in the `repository/` directory. This is important to include, because it allows the current SuperTux release to always get its versions of all addons for backwards compatibility.
+* **addon-md5-checksum** represents your new, modified addon archive's MD5 checksum hash. This needs to be updated every time the addon is updated, because the game will not be able to download your addon otherwise. The MD5 checksum is being used for checking the integrity of the addon.
+* For the rest of the entries, the rules listed above for addon `.nfo` files also apply here.

index-0_3_5.nfo

@@ -1,130 +1,144 @@
 (supertux-addons
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Tux Strikes Back")
-	  (author "Christian Schaefers")
-	  (license "freeware that must not be sold provided \"as is\" without express or implied warranty")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/tsblevels.zip")
-	  (file "tsblevels.zip")
-	  (md5 "6ae86eb74087ea341261832bec0e3377")
-	)
-	(supertux-addoninfo
-		(kind "World")
-		(title "Mattie's World")
-		(author "LMH")
-		(license "GPL 2 / CC-by-sa 3.0")
-		(http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/mattie_world_0_3_4.zip")
-		(file "mattie_world_0_3_4.zip")
-		(md5 "b7d1bdb30e80657009963307fc8e3351")
-	)
-	(supertux-addoninfo
-	  (kind "World")
-	  (title "Hume's 2 worldmaps")
-	  (author "Hume")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/hume_worlds.zip")
-	  (file "hume_worlds.zip")
-	  (md5 "8c638482cb30a713c88723fcb736f315")
-	)
-	(supertux-addoninfo
-	  (kind "World")
-	  (title "CT's 2 worldmaps")
-	  (author "CT .da'Bomb")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/ct_worlds.zip")
-	  (file "ct_worlds.zip")
-	  (md5 "17651bb3c8197d3fc055f4699a8f9821")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Octo's Levels")
-	  (author "Octo")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/octo.zip")
-	  (file "octo.zip")
-	  (md5 "86b0594921d455d09cd735765f009db0")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Yeti's Revenge")
-	  (author "niso")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/YETIS_REVENGE_update4.zip")
-	  (file "YETIS_REVENGE_update3.zip")
-	  (md5 "190717c677d7137b5db8ff557e01b954")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Island of Moob")
-	  (author "treskalle")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/moob-island-beta7.zip")
-	  (file "moob-island-beta7.zip")
-	  (md5 "ae05a9fd311744e90c84ebbfd492a9ef")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "The Valley of Chaos")
-	  (author "SemajD")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/The_Valley_Of_Chaos.zip")
-	  (file "The_Valley_Of_Chaos.zip")
-	  (md5 "be79609245c5d14bae4010e33bafe351")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Narre Land")
-	  (author "Narre")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/narre_addon.zip")
-	  (file "narre_addon.zip")
-	  (md5 "b40559513180c61e76b636201a1b69d8")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Levels of Wolfs")
-	  (author "Wolfs")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/levels-of-wolfs.zip")
-	  (file "levels-of-wolfs.zip")
-	  (md5 "e3f18430d4558ee68d8ab2b04a2f4805")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Rubberducks levels")
-	  (author "Basti")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/rubberduck.zip")
-	  (file "rubberduck.zip")
-	  (md5 "96fd633c272382a9776eb0a6ff61f34d")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Lolkat's Levels")
+  (supertux-addoninfo
+    (id "cschaefer-tux-strikes-back")
+    (version 2)
+    (type "worldmap")
+    (title "Tux Strikes Back")
+    (author "Christian Schaefers")
+    (license "CC BY-SA 4.0+")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/cschaefer-tux-strikes-back_v2.zip")
+    (md5 "155f9ef8a3189e47da6c38288379d7da")
+   )
+  (supertux-addoninfo
+    (id "lmh-matties-world")
+    (version 3)
+    (type "world")
+    (title "Mattie's World")
+    (author "LMH")
+    (license "GPL 2 / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/lmh-matties-world_v4.zip")
+    (md5 "e6687a081c1f77ceee20f002835063ee")
+   )
+  (supertux-addoninfo
+    (id "hume-worldmaps")
+    (version 2)
+    (type "world")
+    (title "Hume's 2 worldmaps")
+    (author "Hume")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/hume-worldmaps_v2.zip")
+    (md5 "8c638482cb30a713c88723fcb736f315")
+   )
+  (supertux-addoninfo
+    (id "ctdabomb-worldmaps")
+    (version 1)
+    (type "world")
+    (title "CT's 2 worldmaps")
+    (author "CT .da'Bomb")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/ctdabomb-worldmaps_v1.zip")
+    (md5 "85da2891661f043e0b80a9a6c8ea60dc")
+   )
+  (supertux-addoninfo
+    (id "octo-levels")
+    (version 1)
+    (type "worldmap")
+    (title "Octo's Levels")
+    (author "Octo")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/octo-levels_v1.zip")
+    (md5 "1b3d29a02edc7cd34ba166db110037cd")
+   )
+  (supertux-addoninfo
+    (id "niso-yetis-revenge")
+    (version 2)
+    (type "worldmap")
+    (title "Yeti's Revenge")
+    (author "niso")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/niso-yetis-revenge_v2.zip")
+    (md5 "cbe954f4a0cc994e54d03b3978feb2cc")
+   )
+  (supertux-addoninfo
+    (id "treskalle-island-of-moob")
+    (version 1)
+    (type "worldmap")
+    (title "Island of Moob")
+    (author "treskalle")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/treskalle-island-of-moob_v1.zip")
+    (md5 "49cd84a701d03053fd0fe7e161483e08")
+   )
+  (supertux-addoninfo
+    (id "semajd-valley-of-chaos")
+    (version 1)
+    (type "worldmap")
+    (title "The Valley of Chaos")
+    (author "SemajD")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/semajd-valley-of-chaos_v1.zip")
+    (md5 "0f50ad2412bc220bd6e5fb5d02e0f75e")
+   )
+  (supertux-addoninfo
+    (id "narre-land")
+    (version 1)
+    (type "worldmap")
+    (title "Narre Land")
+    (author "Narre")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/narre-land_v1.zip")
+    (md5 "c5ce27594195ba9fc086a0fb34fb4fbb")
+   )
+  (supertux-addoninfo
+    (id "wolf-levels")
+    (version 1)
+    (type "worldmap")
+    (title "Levels of Wolfs")
+    (author "Wolfs")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/wolf-levels_v1.zip")
+    (md5 "5cf1bb45f1f639944e7a53736b0e46b9")
+   )
+  (supertux-addoninfo
+    (id "rubberduck-levels")
+    (version 2)
+    (type "worldmap")
+    (title "Rubberducks levels")
+    (author "Basti")
+    (license "GPL 2+ / CC-by-sa 3.0")
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/rubberduck-levels_v2.zip")
+    (md5 "30941bff2497090a93a4d50d262042e5")
+   )
+  (supertux-addoninfo
+    (id "lolkat-levels")
+    (version 1)
+    (type "worldmap")
+    (title "Lolkat's Levels")
     (author "Lolkat")
     (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/lolkat.zip")
-	  (file "lolkat.zip")
-	  (md5 "0d15086eb5ff2fb9c6b9066fe73311af")
-	)
-	(supertux-addoninfo
-	  (kind "Worldmap")
-	  (title "Fiona's World")
-	  (author "LMH")
-	  (license "GPL 2+ / CC-by-sa 3.0")
-	  (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps-0_3_5/fiona.zip")
-	  (file "fiona.zip")
-	  (md5 "6da14cdf93e1118fee32788c0aed8a40")
-	)
-
-        (supertux-addoninfo
-         (kind "Worldmap")
-         (title "Halloween 2014")
-         (author "SuperTux Team")
-         (license "GPL 2+ / CC-by-sa 3.0")
-         (http-url "https://raw.githubusercontent.com/SuperTux/addons/master/Worldmaps/halloween2014.zip")
-         (file "halloween2014.zip")
-         (md5 "28db69d4e84763277c02fdfd3d532eb0"))
-
+    (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/lolkat-levels_v1.zip")
+    (md5 "059146860c00cedfff08e688095b6216")
+  )
+  (supertux-addoninfo
+     (id "lmh-fionas-world")
+     (version 2)
+     (type "worldmap")
+     (title "Fiona's World")
+     (author "LMH")
+     (license "GPL 2+ / CC-by-sa 3.0")
+     (url "https://raw.githubusercontent.com/SuperTux/addons/master/repository/outdated/lmh-fionas-world_v2.zip")
+     (md5 "b521546dc994d50f10122cad18cca078")
+  )
+  (supertux-addoninfo
+      (id "halloween2014")
+      (version 1)
+      (type "worldmap")
+      (title "Halloween 2014")
+      (author "SuperTux Team")
+      (license "GPL 2+ / CC-by-sa 3.0")
+      (url "https://raw.githubusercontent.com/SuperTux/addons/25dbd9f7feded11079205b562360c3727915a5ad/repository/halloween-2014.zip")
+      (md5 "28db69d4e84763277c02fdfd3d532eb0")
+  )
 )
 
+;; EOF ;;