Add Randomizer & Archipelago functionality to Forge Adventure

ARCHIPELAGO.md

@@ -0,0 +1,85 @@
+## Offline Randomizer
+
+### 🎲 Randomized Adventure Mode
+Play the Adventure mode on the Shandalar world but with randomized items & biomes. Unlock each region of the map as you progress.
+- All cards outside your starting deck will be locked by default.
+- Biomes, cards and equipment unlocks are randomized and can be unlocked by completing various objectives in the game such as:
+    - Collecting cards
+    - Completing quests
+    - Winning battles
+    - Competing at Inn events
+    - Defeating bosses and mini-bosses
+- Equipment shop contents are fully randomized and (almost) any piece of equipment in game can show up.
+- The Leather Boots in your starting equipment are removed regardless of difficulty, all entities' base speeds are increased to compensate.
+
+## Archipelago Multiworld Randomizer
+Archipelago is a cross-game modification system which randomizes different games, then uses the result to build a single
+unified multi-player game. Items from one game may be present in another, and you will need your fellow players to find
+items you need in their games to help you complete your own.
+
+### 🏝️ Archipelago Adventure Mode
+Play the Randomized Adventure Mode using Archipelago to shuffle all items and locations amongst a pool of other Archipelago compatible games.
+<br/>Archipelago adds the following locations to the pool:
+- Buying items from equipment & item shops
+- Defeating a mini-boss
+- Defeating a castle boss
+- Winning a certain number of battles per region
+- Completing a certain number of quests per region
+- Finishing a certain number of inn events per region
+- Collecting a certain number of cards per rarity
+
+This Archipelago implementation adds the following rewards and filler rewards to the pool:
+- Region unlocks in the form of "region runes", one per color of region
+- Gold in various amounts
+- Mana Shards in various amounts
+- Bronze/Silver/Gold Challenge Coins
+- Sets of cards including a free matching booster pack
+- Max life in various amounts
+- Pieces of equipment for the player to wear
+
+This Archipelago implementation has the following win-conditions:
+- Defeating X amount of Castle bosses, this defaults to 3 but when set to all 6, Emrakul must also be defeated in order to win.
+
+#### Generating the Archipelago Multiworld
+1. Download the [latest release](https://github.com/BramTeurlings/forge-archipelago/releases) of this repository
+2. Download the [latest release](https://github.com/BramTeurlings/forge-APWorld/releases) of the Forge APWorld repository
+3. Download the [latest release](https://github.com/ArchipelagoMW/Archipelago/releases) of the Archipelago Launcher
+4. Install Card-Forge using the `forge-installer-<VERSION>.jar` file bundled in this repository's release files
+5. Install the Archipelago Launcher by opening the `Setup.Archipelago.<VERSION>.exe` bundled in Archipelago Launcher release files
+6. Open the Archipelago Launcher and click "Open" on the "Install APWorld" option.![img.png](docs/Adventure/Archipelago/archipelago_launcher_1.png)
+7. When prompted, select the `forge.apworld` file downloaded from the Forge APWorld repository release files.
+8. Once complete, restart the launcher.
+9. Click "Open" on the "Options Creator" option.
+10. Scroll down the list on the left side until you see "Forge" or "ForgeAP" and click on it.![img.png](docs/Adventure/Archipelago/archipelago_launcher_2.png)
+11. Configure the options in the section marked in blue as you choose, if you're not sure what to change it is recommended you leave things on their default values.
+12. Fill your name into the "Player Name" field.
+13. Click on the "Export Options" to export your player profile as a `.yaml` file.
+14. Gather the other player's `.yaml` files and place them into the same "Players" folder. In our example, the Archipelago Launcher put them in `C:\ProgramData\Archipelago\Players`.
+15. Click on the "Generate" option.![img.png](docs/Adventure/Archipelago/archipelago_launcher_3.png)
+16. If everything went well, the Archipelago Launcher will now have generated a `.zip` file for your Archipelago game. This file can be hosted via [Archipelago's Official Website](https://archipelago.gg/uploads) to start a lobby. Our `.zip` file was generated in `C:\ProgramData\Archipelago\output`.
+
+#### Connecting the game client
+17. Assuming you installed Card-Forge in step 4, open `forge-adventure.exe` from the location you installed Card-Forge in.
+18. Select "Adventure Mode" on the main menu.![img.png](docs/Adventure/Archipelago/forge_adventure_1.png)
+19. Select "New Game" on the Adventure Mode screen.![img.png](docs/Adventure/Archipelago/forge_adventure_2.png)
+20. On the New Game screen, choose any settings you want but make sure to scroll down and select "Archipelago" as the "Randomizer" option.![img.png](docs/Adventure/Archipelago/forge_adventure_3.png)
+21. Click on the "Start" button.
+22. You will be brought to the game's opening scene, click through the tutorial quest with the Adept Black Wizard and walk through the port. The game will alert you that you need to connect to the Archipelago Server. Click the "Take me there" button.![img.png](docs/Adventure/Archipelago/forge_adventure_4.png)
+23. Fill in the server host address, the server port and the slot name for your character and click on "Connect".![img.png](docs/Adventure/Archipelago/forge_adventure_5.png) 
+24. **Note: You must reconnect to Archipelago each time you load your save file or restart the software. You can find the connection page by opening the Adventure Mode menu on the overworld via the hamburger-menu icon or by pressing the `esc` key. Click on the Archipelago icon to open the connection menu. This button is only available in Archipelago Randomizer mode.**![img.png](docs/Adventure/Archipelago/forge_adventure_6.png)
+25. You're all set to go! Enjoy playing the Archipelago!
+
+**Extra: If you want the game to automatically download relevant card-artwork, open the Adventure Mode menu and click on "Settings", then scroll down until you see "Automatically Download Missing Card Art" and enable the option.**
+
+## Cheating
+In rare cases due to the nature of the game, it's possible to get stuck, either literally (like, in a wall or something) or other times due to difficulty.
+I should note that the generation of the multiworld **should** ensure that you can't be progression locked by Archipelago but nevertheless, sometimes you might have a lot more fun if you just had that little bit of extra gold or that one card you need.
+
+While cheating is obviously not in the spirit of the game, it can genuinely improve certain player's enjoyment so we leave the final call to you.
+Here are some handy cheats that will help you progress and speed up your game. Note that each of these commands must be filled into the in-game console, you can open the console by pressing `F9`:
+1. `give gold [amount]` > gives the specified amount of gold to the player.
+2. `give shards [amount]` > gives the specified amount of shards to the player.
+3. `give item cheat` > gives the player a completely busted piece of equipment that will auto-win almost any combat on the first turn, don't forget to equip it, you can un-equip it at any time.
+4. `give boosters [set-code] [amount]` > gives the player the specified amount of packs of the specified set code. Set codes can be found online.
+5. `heal full` > fully heals your character
+6. `teleport to poi Spawn` > teleports you to the starting cave, handy if you ever get literally stuck. It's case sensitive so don't forget the capital "S".

README.md

@@ -46,6 +46,7 @@ Embark on a thrilling single-player journey where you can:
 - Explore an overworld map.
 - Challenge diverse AI opponents.
 - Collect cards and items to boost your abilities.
+- Archipelago Multiworld compatibility
 
 <img width="1282" height="752" alt="Shandalar World" src="https://github.com/user-attachments/assets/9af31471-d688-442f-9418-9807d8635b72" />
 

docs/_sidebar.md

@@ -62,6 +62,6 @@
   - [Fantasy Blocks](fantasy-blocks.md)
 
 - [Missing Cards in Forge](Missing-Cards-in-Forge.md)
-  - [Un‐cards, Playtest Cards, and Other Funny Cards](Un‐cards,-Playtest-Cards,-and-Other-Funny-Cards.md)
+  - [Un‐cards, Playtest Cards, and Other Funny Cards](Un-cards,-Playtest-Cards,-and-Other-Funny-Cards.md)
 
 - [Credit & Thanks](Credit-and-Thanks.md)

forge-core/src/main/java/forge/item/PaperCard.java

@@ -64,6 +64,7 @@ public class PaperCard implements Comparable<IPaperCard>, InventoryItemFromSet,
     private transient String displayName;
     private transient String sortableName;
     private transient boolean hasFlavorName;
+    private transient boolean isLocked;
 
     @Override
     public String getName() {
@@ -534,6 +535,14 @@ public List<ICardFace> getAllFaces() {
         return this.rules.getAllFaces().stream().map(this::getVariantForFace).collect(Collectors.toList());
     }
 
+    public boolean isLocked() {
+        return isLocked;
+    }
+
+    public void setLocked(boolean locked) {
+        isLocked = locked;
+    }
+
     private ICardFace getVariantForFace(ICardFace face) {
         if(!face.hasFunctionalVariants() || this.functionalVariant.equals(NO_FUNCTIONAL_VARIANT))
             return face;

forge-gui-android/pom.xml

@@ -99,6 +99,16 @@
         <finalName>forge-android-${snapshot-version}</finalName>
     </build>
     <dependencies>
+        <dependency>
+            <groupId>org.java-websocket</groupId>
+            <artifactId>Java-WebSocket</artifactId>
+            <version>1.5.6</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents.core5</groupId>
+            <artifactId>httpcore5</artifactId>
+            <version>5.2.4</version>
+        </dependency>
         <dependency>
             <groupId>org.robolectric</groupId>
             <artifactId>android-all</artifactId>

forge-gui-mobile/pom.xml

@@ -110,6 +110,11 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.github.archipelagomw</groupId>
+            <artifactId>Java-Client</artifactId>
+            <version>0.2.0</version>
+        </dependency>
     </dependencies>
 
 </project>

forge-gui-mobile/src/forge/adventure/archipelago/Archipelago.java

@@ -0,0 +1,74 @@
+package forge.adventure.archipelago;
+
+import com.github.tommyettinger.textra.TypingLabel;
+import io.github.archipelagomw.ClientStatus;
+
+import java.net.URISyntaxException;
+import java.util.*;
+
+public class Archipelago {
+    private final Random random = new Random();
+
+    public static Archipelago instance = null;
+
+    static private ArchipelagoClient APClient;
+
+    public Archipelago() {
+        instance = this;
+    }
+
+    public static Archipelago getInstance() {
+        return instance == null ? instance = new Archipelago() : instance;
+    }
+
+    public void connect(String ip, String port, String slotName, String password, TypingLabel connectStatusLabel) {
+        if (APClient != null && APClient.isConnected()) APClient.disconnect();
+
+        APClient = new ArchipelagoClient(connectStatusLabel);
+        APClient.setName(slotName);
+        APClient.setPassword(password);
+
+        String address = ip;
+        if (port != null && !port.isEmpty() && !address.contains(":")) address += ":" + port;
+
+        try {
+            APClient.connect(address);
+        } catch (URISyntaxException e) {
+            connectStatusLabel.setText("");
+            connectStatusLabel.setText("{FADE=RED;RED;0.1}Invalid IP");
+        }
+    }
+
+    public void disconnect() {
+        if (APClient != null && APClient.isConnected()) APClient.disconnect();
+    }
+
+    public boolean isConnected() {
+        return APClient != null && APClient.isConnected();
+    }
+
+    public void checkLocation(Long id) {
+        if (APClient == null || !APClient.isConnected() || !APClient.checkLocation(id)) {
+            ArchipelagoRandomizer.getInstance().locationQueue.add(id);
+        }
+    }
+
+    public boolean checkLocations(List<Long> ids) {
+        return APClient.checkLocations(ids);
+    }
+
+    public void goal() {
+        APClient.setGameState(ClientStatus.CLIENT_GOAL);
+    }
+
+    public int getRandomItemPrice() {
+        int min = 500;
+        int max = 1000;
+        SlotData slotData = APClient.getSlotData();
+        if (slotData != null) {
+            min = slotData.MinShopPrice;
+            max = slotData.MaxShopPrice;
+        }
+        return random.nextInt(min, max + 1);
+    }
+}

forge-gui-mobile/src/forge/adventure/archipelago/ArchipelagoCheckTypes.java

@@ -0,0 +1,12 @@
+package forge.adventure.archipelago;
+
+public enum ArchipelagoCheckTypes {
+    COLORLESS_BATTLE_WON, WHITE_BATTLE_WON, BLUE_BATTLE_WON, BLACK_BATTLE_WON, RED_BATTLE_WON, GREEN_BATTLE_WON,
+    COLORLESS_TOWN_QUESTS, WHITE_TOWN_QUESTS, BLUE_TOWN_QUESTS, BLACK_TOWN_QUESTS, RED_TOWN_QUESTS, GREEN_TOWN_QUESTS,
+    COLORLESS_TOWN_EVENTS, WHITE_TOWN_EVENTS, BLUE_TOWN_EVENTS, BLACK_TOWN_EVENTS, RED_TOWN_EVENTS, GREEN_TOWN_EVENTS,
+    TOTAL_CARDS_EARNED,
+    SLIME_MOTHER_DEFEATED, SLOBAD_DEFEATED, XIRA_DEFEATED, NAHIRI_DEFEATED, VALYX_DEFEATED, JACE_DEFEATED, KIORA_DEFEATED, MYR_SUPERION_DEFEATED, SLIVER_QUEEN_DEFEATED, TEFERI_DEFEATED, GROLNOK_DEFEATED, GUARDIAN_ANGEL_DEFEATED,
+    LILIANA_DEFEATED, SLIMEFOOT_DEFEATED, SORIN_DEFEATED, CHANDRA_DEFEATED, TIBALTS_TORTURER_DEFEATED, TIBALT_DEFEATED, ZEDRUUS_COOK_DEFEATED, CONJURER_DEFEATED, ZEDRUU_DEFEATED, GARRUK_DEFEATED, HYDRA_OF_SHANDALAAR_DEFEATED, SCARECROW_CAPTAIN_DEFEATED,
+    BOSS_WHITE_DEFEATED, BOSS_BLUE_DEFEATED, BOSS_BLACK_DEFEATED, BOSS_RED_DEFEATED, BOSS_GREEN_DEFEATED, BOSS_COLORLESS_DEFEATED,
+    WIN_CONDITION_CLEARED
+}

forge-gui-mobile/src/forge/adventure/archipelago/ArchipelagoClient.java

@@ -0,0 +1,44 @@
+package forge.adventure.archipelago;
+
+import com.github.tommyettinger.textra.TypingLabel;
+import forge.adventure.archipelago.events.*;
+import io.github.archipelagomw.Client;
+import io.github.archipelagomw.flags.ItemsHandling;
+
+import javax.annotation.Nullable;
+
+public class ArchipelagoClient extends Client {
+
+    @Nullable
+    public SlotData slotData;
+
+    public ArchipelagoClient(TypingLabel connectStatusLabel) {
+        super();
+
+        this.setGame("ForgeAP");
+        this.setItemsHandlingFlags(ItemsHandling.SEND_ITEMS | ItemsHandling.SEND_OWN_ITEMS | ItemsHandling.SEND_STARTING_INVENTORY);
+        this.getEventManager().registerListener(new ConnectResult(this, connectStatusLabel));
+        this.getEventManager().registerListener(new ReceiveItem());
+        this.getEventManager().registerListener(new LocationInfo(this));
+        this.getEventManager().registerListener(new OnDeathLink(this));
+        this.getEventManager().registerListener(new PrintJsonListener(this));
+    }
+
+    public void setSlotData(SlotData slotData) {
+        this.slotData = slotData;
+    }
+
+    @Nullable
+    public SlotData getSlotData() {
+        return slotData;
+    }
+
+    @Override
+    public void onError(Exception ex) {
+        ex.getLocalizedMessage();
+    }
+
+    @Override
+    public void onClose(String s, int i) {
+    }
+}

forge-gui-mobile/src/forge/adventure/archipelago/ArchipelagoColors.java

@@ -0,0 +1,10 @@
+package forge.adventure.archipelago;
+
+public class ArchipelagoColors {
+    public static final String Cyan = "{COLOR=#00CCCC}";
+    public static final String Plum = "{COLOR=#AF99EF}";
+    public static final String SlateBlue = "{COLOR=#6D8BE8}";
+    public static final String Salmon = "{COLOR=#FA8072}";
+    public static final String Green = "{COLOR=#00b359}";
+    public static final String Magenta = "{COLOR=#EE00EE}";
+}