Sync again

Author: tool4EvEr

docs/Adventure-Items.md

@@ -5,7 +5,7 @@ Adventure mode is a work-in-progress game mode where you explore the ever-changi
 # How to run?
 
 1. Step 1: Download the latest version of Forge https://downloads.cardforge.org/dailysnapshots/ 
-2. Step 2: Make sure you have the requirerd version of the JDK (https://www.oracle.com/be/java/technologies/downloads/)
+2. Step 2: Make sure you have the required version of the JDK (https://www.oracle.com/be/java/technologies/downloads/)
 3. Step 3: Launch the adventure mode from the "adventure.exe" file included in the forge version (on android, the adventure version should be embedded into the main Forge program)
 4. Step 4: In order to have pictures show up make sure you enable "automatically download missing card images" in the settings. This should automatically download the picture of the card as you encounter them in game. 
 

docs/Adventure-Mode.md

@@ -37,7 +37,7 @@ Card images are stored in `pics/cards`, and tokens in `pics/tokens`, in the Cach
 - **Android 8 to 10** - `Internal Storage/Forge/cache/`
 - **Linux** - `/home/<username>/.cache/forge/`
 - **MacOS** - `/Users/<username>/Library/caches/forge/`
-  - Use `Command + Shift + /` to show hidden files.
+  - Use `Command + Shift + .` to show hidden files.
 
 
 # Subfolders

docs/Card-Images.md

@@ -12,33 +12,43 @@ The next tutorial will walk you through the process of adding your new cards to
 Windows:
 > C:/Users/<your username>/Application Data/Roaming/Forge/custom/cards
 
-Mac/Linux:
+Linux:
+> ~/.forge/custom/cards
+
+Mac:
 > TODO Add filepath
 
 ### Custom Tokens
 
 Windows:
 > C:/Users/<your username>/Application Data/Roaming/Forge/custom/tokens
 
-Mac/Linux:
+Linux:
+> ~/.forge/custom/tokens
+
+Mac:
 > TODO Add filepath
 
 ### Custom Editions
 
 > C:/Users/<your username>/Application Data/Roaming/Forge/custom/editions
 
-Mac/Linux:
+Linux:
+> ~/.forge/custom/editions
+
+Mac:
 > TODO Add filepath
 
 ### Card Images
 
 Windows:
 > C:/Users/<your username>/Application Data/Local/Forge/Cache/pics/cards
 
-Mac/Linux:
-> TODO Add filepath
-
+Linux:
+> ~/.cache/forge/pics/cards
 
+Mac:
+> TODO Add filepath
 
 ## Creating a New Card
 

docs/Creating-a-Custom-Card.md

@@ -18,12 +18,12 @@ The important folders are the following (you can create them if they don't exist
 
 ### Image files
 
-Your card and token images go into `%appdata%/../Local/Forge/Cache/pics`.
+Your card and token images go into `%localappdata%/Forge/Cache/pics`.
 
 The important folders are the following:
 
 * **cards**: This is where you will put your card images. You'll want to create a folder with the Code of your edition. The images are named using this convention `Card Name.full.jpg`. If you have multiple art for the same card (something like basic lands, or maybe alternate art of the same card), then you can name them `Card Name1.full.jpg`, `Card Name2.full.jpg`, and so forth.
-* **tokens**: Same as the cards folder, your tokens will go inside this folder. The naming convention is `token_script_name.jpg`. So if your token script name is `b_5_5_golem_trample`, then you can put your token image inside your edition folder named `b_5_5_golem_trample.jpg`.
+* **tokens**: Same as the cards folder, your tokens will go inside this folder. The naming convention is `token_script_name.jpg`. So if your token script name is `b_5_5_golem_trample`, then you can put your token image inside your edition folder named `b_5_5_golem_trample.jpg`. If there is a collector number, append it at the beginning, such as `1_b_5_5_golem_trample.jpg`
 
 ## Creating your edition definition file
 
@@ -60,6 +60,9 @@ Type=Custom
 b_1_1_bird_flying
 b_3_3_cat_deathtouch
 b_5_5_golem_trample
+
+[CreatureTypes]
+Artist:Artists
 ```
 
 Let's break it down.
@@ -77,7 +80,7 @@ The **[metadata]** section contains the information about your edition.
 * **Code** is an **unique** identifier for your edition.
 * **Name** is the name of your edition.
 * **Date** is the date the set was first released/created.
-* **Type** should be Custom as Forge do things differently for them, including but not limited to skipping the automatic download of the images.
+* **Type** should be `Custom` as Forge do things differently for them, including but not limited to skipping the automatic download of the images.
 
 ```
 [cards]
@@ -119,7 +122,7 @@ The **[tokens]** section is optional, and only needed if you want to use specifi
 
 If you load the game with just file, you'll be able to see that Master Chef, Unearth and the basic lands can already be found in game. That's because they share a name with existing Magic the Gathering cards. **However**, [Master Chef](https://msem-instigator.herokuapp.com/card?q=Master+Chef) from MSEM and [Master Chef](https://scryfall.com/card/clb/241/master-chef) from MTG are two different cards! You must ensure that your custom cards do not have the same name as an existing one, unless you just want it to be another print, just like [Unearth](https://msem-instigator.herokuapp.com/card/CHAMPIONS/62/Unearth) and the basic lands in this example.
 
-Let’s comment out Master Chef to avoid a name conflict with an existing MTG card:
+Let's comment out Master Chef to avoid a name conflict with an existing MTG card:
 
 ```
 [cards]
@@ -187,7 +190,12 @@ SVar:Z:Count$Compare X GE6.1.0
 Oracle:At the beginning of your end step, if you lost 2 or more life this turn, create a 1/1 black Bird creature token with flying.\nIf you lost 4 or more life this turn, instead create a 3/3 black Cat creature token with deathtouch.\nIf you lost 6 or more life this turn, instead create a 5/5 black Golem creature token with trample.
 ```
 
-If you load your game now, you should be able to find these cards you just scripted! You'll also notice that Inked Summoner is only listed as a Human Warlock, missing the Artist subtype. That's because Artist is not a real MTG subtype. There is no way to add custom ones in Forge at this moment.
+If you load your game now, you should be able to find these cards you just scripted! You'll also notice that Inked Summoner is only listed as a Human Warlock, missing the Artist subtype. That's because Artist is not a real MTG subtype. You can add custom types directing inside the set definition file by following the sections found inside the `res/lists/TypeLists.txt` file. Duplicates will be ignored.
+
+```
+[CreatureTypes]
+Artist:Artists
+```
 
 Oh no! If you play with Inked Summoner now, you will crash when summoning a token. That's because they don't exist in MTG and we need to define them! Let's go onto the next step!
 
@@ -237,7 +245,7 @@ Great! Now Inked Summoner no longer make the game crash! Now let's add some imag
 
 You can find the card images for the MSEM Champions edition [here](https://msem-instigator.herokuapp.com/set/CHAMPIONS). Find the ones you need and save them inside `%appdata%/../Local/Forge/Cache/pics/cards/MSEM_CHAMPIONS` Remember the filename format should be something like `Swamp.full.jpg` if you only have one variant in your edition. If you have multiples, then it should be something like `Fox of the Orange Orchard1.full.jpg`, `Fox of the Orange Orchard2.full.jpg`, etc. You can find the alternate images from [here](https://msem-instigator.herokuapp.com/set/MPS_MSE) if you want.
 
-For the tokens, we can deposit them inside `%appdata%/../Local/Forge/Cache/pics/tokens/MSEM_CHAMPIONS`. They should be named the same as their token script so `b_1_1_bird_flying.jpg` and so forth.
+For the tokens, we can deposit them inside `%localappdata%/Forge/Cache/pics/tokens/MSEM_CHAMPIONS`. They should be named the same as their token script so `b_1_1_bird_flying.jpg` and so forth.
 
 ![b_1_1_bird_flying](https://github.com/user-attachments/assets/531583c1-3985-4744-858a-3a49fd12740a)
 ![b_3_3_cat_deathtouch](https://github.com/user-attachments/assets/15a24e62-be43-4c0c-aeac-0ddb38fca97a)

docs/Creating-a-custom-set.md

@@ -0,0 +1,35 @@
+# Custom music for adventure mode
+
+In the `res/adventure/common/music` folder resides all the music that is played in various parts of adventure mode:
+
+ * `black` - Tracks that are played in the black magic biome in the overworld
+ * `blue` - Tracks that are played in the blue magic biome in the overworld
+ * `boss` - Tracks that are played in a boss battle
+ * `castle` - Tracks that are played inside biome boss dungeons
+ * `cave` - Tracks that are played in any dungeon that is not a biome boss dungeon
+ * `colorless` - Tracks that are played in the colorless magic (wastes) biome in the overworld
+ * `green` - Tracks that are played in the green magic biome in the overworld
+ * `match` - Tracks that are played during a non-boss battle
+ * `menus` - Tracks that are played in the opening menu of adventure mode
+ * `red` - Tracks that are played in the red magic biome in the overworld
+ * `town` - Tracks that are played when you are in any town
+ * `white` - Tracks that are played in the white magic biome in the overworld
+ 
+The game will play a track from any of the above folders at random. The tracks can be any 
+file name with a `.mp3`, `.wav` or `.m4a` extension.
+
+NOTE: On Steam Deck, if you added Forge Adventure mode to Steam Deck gaming mode, the game may
+have issues playing tracks that have non-ascii characters in its name. A current
+workaround is to rename such tracks with accented characters to their ascii equivalents (eg. `é` to `e`)
+and such tracks will play again. Reference: https://github.com/Card-Forge/forge/issues/8290
+
+To customize the music in adventure mode, simply [add to -OR- replace] the existing music track files in the folders referenced above.
+
+# Custom music for regular Forge
+
+In the `res/music` folder resides all the music that is played in regular Forge if you have music enabled.
+
+ * `match` - Tracks that are played inside a game
+ * `menus` - Tracks that are played outside of any game (ie. menus)
+
+All the same playback rules apply. The process for customizing the music here is the same as adventure mode.

docs/Custom-Music.md

@@ -12,7 +12,7 @@ The "Ancestors" column is basically there to list currently inactive developers
 ## Ingame Engine
 | Concept | Owners | Ancestors | Example tasks |
 | - | - | - | - |
-| Ability Effects | friarsol, Hanmac, Northmoc, TRT | | - support new mechanics<br>- debug complicated reports<br>- improve stackdescriptions |
+| Ability Effects | friarsol, Hanmac, Northmoc, TRT | | - support new mechanics<br>- debug complicated reports<br>- improve stackdescriptions<br>- research rulings<br>- compare with Arena |
 | Adventure | TabletopGeneral | Grimm | |
 
 ## Magic Metadata