From 0565b005f33e12b697a84eae038829995ed30925 Mon Sep 17 00:00:00 2001 From: Joalor64 Date: Mon, 18 Nov 2024 10:22:48 -0500 Subject: [PATCH] quick docs fixes --- docs/Adding-a-New-Achievement.md | 2 +- docs/Adding-a-New-Language.md | 2 +- docs/Adding-a-New-Song.md | 2 +- docs/Creating-a-Mod.md | 4 +++- docs/Custom-Credits.md | 6 +++--- docs/Home.md | 2 +- docs/Scripting.md | 4 ++-- 7 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/Adding-a-New-Achievement.md b/docs/Adding-a-New-Achievement.md index 222e080..069005c 100644 --- 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).
+To actually be able to unlock your custom achievement, you can do it through [scripting](https://github.com/Joalor64GH/Rhythmo-SC/wiki/Scripting).
Example: ```hx import('states.PlayState'); diff --git a/docs/Adding-a-New-Language.md b/docs/Adding-a-New-Language.md index 1d463bf..2314fe3 100644 --- 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`.
Of course, this contains the data for your language.
-To add your data, just copy [this](/assets/languages/en.json), and edit it with your translations. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/Adding-a-New-Song.md b/docs/Adding-a-New-Song.md index 409b063..0b8bdc9 100644 --- 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.
-See [Scripting](./Scripting.md) for more. \ No newline at end of file +See [Scripting](https://github.com/Joalor64GH/Rhythmo-SC/wiki/Scripting) for more. \ No newline at end of file diff --git a/docs/Creating-a-Mod.md b/docs/Creating-a-Mod.md index 4090c96..9af1e9d 100644 --- 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 index 2813dc2..bdde47b 100644 --- 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 index 88f46eb..7b1bda1 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -3,4 +3,4 @@ Welcome to the Rhythmo Modding Wiki.
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. \ No newline at end of file +To get started, see [Creating a Mod](https://github.com/Joalor64GH/Rhythmo-SC/wiki/Creating-a-Mod) first. \ No newline at end of file diff --git a/docs/Scripting.md b/docs/Scripting.md index 3666bfe..e27b7dc 100644 --- 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