add example mod + update readme

Author: ithinkandicode

README.md

@@ -1,2 +1,11 @@
-# examples
-Example mods for ModLoader
+# Mod Loader Examples
+
+This repo has a basic template you can reference when building your own mod. It has lots of comments to help you along the way.
+
+The `root` folder is the same as the root folder in Godot's filesystem.
+
+### Other Games
+
+For other games, see the example mods on their own repo or GitHub organisation. Note that game-specific examples strip away the basics, so this example is always a great place to start.
+
+- [Brotato](https://github.com/BrotatoMods/Brotato-Example-Mods)

root/.import/modname.csv-6dd823a6c81391699d9e2f5557fdbf9b.md5

@@ -0,0 +1,3 @@
+source_md5="990c006fc18c991264c9b01fad4ed97e"
+dest_md5="84df9f68e686067678f1bee07628d502"
+

root/mods-unpacked/AuthorName-ModName/extensions/main.gd

@@ -0,0 +1,48 @@
+extends "res://main.gd"
+
+# Brief overview of what the changes in this file do...
+
+const MYMOD_LOG = "AuthorName-ModName" # ! Change `MODNAME` to your actual mod's name
+
+
+# Extensions
+# =============================================================================
+
+func _ready()->void:
+	# ! Note that we're *not* calling `.return` here. This is because, unlike
+	# ! all other vanilla funcs (eg `get_gold_bag_pos` below), _ready will
+	# ! always fire, regardless of your code. In all other cases, we would still
+	# ! need to call it
+
+	# ! Note that you won't see this in the log immediately, because main.gd
+	# ! doesn't run until you start a run
+	ModLoaderUtils.log_info("Ready", MYMOD_LOG)
+
+	# ! These are custom functions. It will run after vanilla's own _ready is
+	# ! finished
+	_modname_my_custom_edit_1()
+	_modname_my_custom_edit_2()
+
+
+# This is the name of a func in vanilla
+func get_gold_bag_pos()->Vector2:
+	# ! This calls vanilla's version of this func. The period (.) before the
+	# func lets you call it without triggering an infinite loop. In this case,
+	# we're calling the vanilla func to get the original value; then, we can
+	# modify it to whatever we like
+	var gold_bag_pos = .get_gold_bag_pos()
+
+	# ! If a vanilla func returns something (just as this one returns a Vector2),
+	# ! your modded funcs should also return something with the same type
+	return gold_bag_pos
+
+
+# Custom
+# =============================================================================
+
+func _modname_my_custom_edit_1()->void: # ! `void` means it doesn't return anything
+	pass # ! Using `pass` here allows you to have a empty func without causing errors
+
+
+func _modname_my_custom_edit_2()->void:
+	ModLoaderUtils.log_info("Main.gd has been modified", MYMOD_LOG)

root/mods-unpacked/AuthorName-ModName/manifest.json

@@ -0,0 +1,17 @@
+{
+	"name": "ModName",
+	"namespace": "AuthorName",
+	"version_number": "1.1.0",
+	"description": "Description of your mod...",
+	"website_url": "https://github.com/exampleauthor/examplemod",
+	"dependencies": [],
+	"extra": {
+		"godot": {
+			"incompatibilities": [],
+			"authors": ["AuthorName"],
+			"compatible_mod_loader_version": "3.0.0",
+			"compatible_game_version": ["0.6.1.6"],
+			"config_defaults": {}
+		}
+	}
+}

root/mods-unpacked/AuthorName-ModName/mod_main.gd

@@ -0,0 +1,51 @@
+extends Node
+
+# Brief overview of what your mod does...
+
+# ! Comments prefixed with "!" mean they are extra info. Comments without them
+# ! should be kept because they give your mod structure and make it easier to
+# ! read by other modders
+
+
+const MOD_DIR = "AuthorName-ModName/" # name of the folder that this file is in
+const MYMOD_LOG = "AuthorName-ModName" # full ID of your mod (AuthorName-ModName)
+
+
+var dir = ""
+var ext_dir = ""
+
+
+func _init(modLoader = ModLoader):
+	ModLoaderUtils.log_info("Init", MYMOD_LOG)
+
+	# ! We can't use `ModLoader` because the ModLoader instance isn't available
+	# ! at this point in the mod's loading process. Instead, the class instance
+	# ! is passed to a mod's `_init` func via the variable `modLoader`.
+	# ! It will be available in any other places in your mod though, such as in
+	# ! your _ready func.
+	dir = modLoader.UNPACKED_DIR + MOD_DIR
+	ext_dir = dir + "extensions/" # ! any script extensions should go in this folder, and should follow the same folder structure as vanilla
+
+	# Add extensions
+	modLoader.install_script_extension(ext_dir + "main.gd") # brief description of this edit...
+	#modLoader.install_script_extension(ext_dir + "entities/units/player/player.gd") # ! Note that this file does not exist in this example mod
+
+	# ! Add extensions (longform version of the above)
+	#modLoader.install_script_extension("res://mods-unpacked/AuthorName-ModName/extensions/main.gd")
+	#modLoader.install_script_extension("res://mods-unpacked/AuthorName-ModName/extensions/entities/units/player/player.gd")
+
+	# Add translations
+	# ! Load translations for your mod, if you need them.
+	# ! Add translations by adding a CSV called "modname.csv" into the "translations" folder.
+	# ! Godot will automatically generate a ".translation" file, eg "modname.en.translation".
+	# ! Note that in this example, only the file called "modname.csv" is custom;
+	# ! any other files in the "translations" folder were automatically generated by Godot
+	modLoader.add_translation_from_resource(dir + "translations/modname.en.translation")
+
+
+func _ready()->void:
+	ModLoaderUtils.log_info("Ready", MYMOD_LOG)
+
+	# ! This uses Godot's native `tr` func, which translates a string. You'll
+	# ! find this particular string in the example CSV here: translations/modname.csv
+	ModLoaderUtils.log_info(str("Translation Demo: ", tr("MODNAME_READY_TEXT")), MYMOD_LOG)

root/mods-unpacked/AuthorName-ModName/translations/modname.csv

@@ -0,0 +1,5 @@
+keys,en
+MODNAME_EXAMPLE_STRING,This is an example. If you use "EXAMPLE_STRING" for things like character names it will show this text instead
+MODNAME_READY_TEXT,This mod's translation file is working correctly!
+MODNAME_COMMA_NOTE,"If your string contains a comma like this, you need to wrap the string in double quotes, otherwise it a) won't load, and b) will stop any strings below it from loading."
+MODNAME_NOTE,Note that the only custom file in this directory is 'modname.csv'. The other files are generated automatically when you add a CSV to the Godot editor's filesystem

root/mods-unpacked/AuthorName-ModName/translations/modname.csv.import

@@ -0,0 +1,16 @@
+[remap]
+
+importer="csv_translation"
+type="Translation"
+
+[deps]
+
+files=[ "res://mods-unpacked/AuthorName-ModName/translations/modname.en.translation" ]
+
+source_file="res://mods-unpacked/AuthorName-ModName/translations/modname.csv"
+dest_files=[ "res://mods-unpacked/AuthorName-ModName/translations/modname.en.translation" ]
+
+[params]
+
+compress=true
+delimiter=0