quick docs fixes

JoaTH-Team · Nov 18, 2024 · 0565b00 · 0565b00
1 parent d797d37
commit 0565b00
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 10 deletions.
diff --git a/docs/Adding-a-New-Achievement.md b/docs/Adding-a-New-Achievement.md
@@ -15,7 +15,7 @@ Now, you simply need an icon for your achievement. Your icon should be in `asset
 I recommend that the image's size should be a square, preferably `150 x 150`.
 
 ## Unlocking your Achievement
-To actually be able to unlock your custom achievement, you can do it through [scripting](./Scripting.md). <br>
+To actually be able to unlock your custom achievement, you can do it through [scripting](https://github.com/Joalor64GH/Rhythmo-SC/wiki/Scripting). <br>
 Example:
 ```hx
 import('states.PlayState');

diff --git a/docs/Adding-a-New-Language.md b/docs/Adding-a-New-Language.md
@@ -15,4 +15,4 @@ Deutsch (Deutschland):de
 
 Now, you need your `.json` file, which should be located in `assets/languages/[language-code].json`. <br>
 Of course, this contains the data for your language. <br>
-To add your data, just copy [this](/assets/languages/en.json), and edit it with your translations.
+To add your data, just copy [this](https://raw.githubusercontent.com/Joalor64GH/Rhythmo-SC/main/assets/languages/en.json), and edit it with your translations.
diff --git a/docs/Adding-a-New-Song.md b/docs/Adding-a-New-Song.md
@@ -38,4 +38,4 @@ Also, the size of your cover should be a square, preferably `720 by 720`.
 
 ## Adding a Script (Optional)
 Additionally, you also add in a script that will only run on a specific song. <br>
-See [Scripting](./Scripting.md) for more.
+See [Scripting](https://github.com/Joalor64GH/Rhythmo-SC/wiki/Scripting) for more.
diff --git a/docs/Creating-a-Mod.md b/docs/Creating-a-Mod.md
@@ -11,7 +11,7 @@ The mod metadata comes in two files. Those two files are `_polymod_meta.json` an
 ### `_polymod_meta.json` (Required)
 In `_polymod_meta.json`, you can define the mod name, the name of the author, etc.
 
-Example:
+Here's an example of a valid mod metadata file:
 ```json
 {
 	"title": "Template",
@@ -23,6 +23,8 @@ Example:
 }
 ```
 
+Note that both `api_version` and `mod_version` should use valid [Semantic Versioning 2.0.0](https://semver.org/) values.
+
 ### `_polymod_icon.png` (Optional)
 As for `_polymod_icon.png`, it's just a simple `.png` icon for the mod. Any square image is recommended, preferably `150 x 150`. Just keep in mind that **whatever image it is, it will always be squished into a `75 x 75` resolution**.
 

diff --git a/docs/Custom-Credits.md b/docs/Custom-Credits.md
@@ -1,10 +1,10 @@
 ## Credits Data
-In `assets/credits.json`, you can set the following fields:
+In `assets/credits.json`, you can edit the following fields:
 * `menuBG` - Your custom menu background.
 * `menuBGColor` - The color of your custom background (`[R, G, B]`).
 * `tweenColor` - If the colors should set to the user's colors or not.
 
-Then, in the `users` array, copy this credit block:
+Then, in the `users` array, copy-and-paste this credit block:
 ```json
 {
     "sectionName": "Section",
@@ -20,7 +20,7 @@ Then, in the `users` array, copy this credit block:
  }
  ```
 
-Explanation:
+You can then edit the following:
 * `sectionName` *(optional)* - A header you can place in a specific user block.
 * `name` - The user's name.
 * `iconData` - An array with the filename for their icon, and optional X and Y offsets for positioning the icon.

diff --git a/docs/Home.md b/docs/Home.md
@@ -3,4 +3,4 @@ Welcome to the Rhythmo Modding Wiki. <br>
 Here you will find documentation and guides on how to make a mod in this game.
 
 ## Getting Started
-To get started, see [Creating a Mod](./Creating-a-Mod.md) first.
+To get started, see [Creating a Mod](https://github.com/Joalor64GH/Rhythmo-SC/wiki/Creating-a-Mod) first.
diff --git a/docs/Scripting.md b/docs/Scripting.md
@@ -22,7 +22,7 @@ The following are not supported:
 * `platform` - Returns the current platform (e.g., Windows, Linux).
 
 ## Default Functions
-* `import` - See [Imports](https://github.com/Joalor64GH/Rhythmo-SC/blob/main/docs/Scripting.md#imports) for more.
+* `import` - See [Imports](https://github.com/Joalor64GH/Rhythmo-SC/wiki/Scripting#imports) for more.
 * `trace` - The equivalent of `trace` in normal Haxe.
 * `stopScript` - Stops the current script.
 * `addScript` - Adds a new script to `scriptArray` (Used in `PlayState.hx` only).
@@ -122,7 +122,7 @@ importScript('path.to.script');
 ```
 
 ## Templates
-Some useful templates. For the default template, use [this](/assets/scripts/template.hxs).
+Some useful templates. For the default template, use [this](https://raw.githubusercontent.com/Joalor64GH/Rhythmo-SC/main/assets/scripts/template.hxs).
 
 ### FlxSprite
 ```hx