Merge pull request #9077 from paulsnoops/edition-updates

Edition updates: PSPL, PURL, PW25, SLC, SLD, TLA, TLE

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,6 +4,7 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
+type: 'Bug'
 
 ---
 
@@ -31,7 +32,6 @@ If applicable, add screenshots to help explain your problem.
 **Smartphone (please complete the following information):**
  - Device: [e.g. iPhone6]
  - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
  - Version [e.g. 22]
 
 **Additional context**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,6 +4,7 @@ about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
+type: 'Feature'
 
 ---
 

.github/workflows/maven-publish.yml

@@ -2,10 +2,21 @@ name: Publish Desktop Forge
 
 on:
   workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: false
+      release_android:
+        type: boolean
+        description: 'Also try to release android build'
+        required: false
+        default: false
 
 jobs:
   build:
-
+    if: github.repository_owner == 'Card-Forge'
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -14,10 +25,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: '11'
+          java-version: '17'
           distribution: 'temurin'
           cache: 'maven'
           server-id: cardforge-repo
@@ -32,10 +43,134 @@ jobs:
         run: |
           git config user.email "actions@github.com"
           git config user.name "GitHub Actions"
-      - name: Build/Install/Publish to GitHub Packages Apache Maven
+
+      - name: Install old maven (3.8.1)
+        run: |
+          curl -o apache-maven-3.8.1-bin.tar.gz https://archive.apache.org/dist/maven/maven-3/3.8.1/binaries/apache-maven-3.8.1-bin.tar.gz
+          tar xf apache-maven-3.8.1-bin.tar.gz
+          export PATH=$PWD/apache-maven-3.8.1/bin:$PATH
+          export MAVEN_HOME=$PWD/apache-maven-3.8.1
+          mvn --version    
+
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+
+      - name: Setup android requirements
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.release_android }}
+        run: |
+          JAVA_HOME=${JAVA_HOME_17_X64} ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --sdk_root=$ANDROID_SDK_ROOT --install "build-tools;35.0.0" "platform-tools" "platforms;android-35"
+          cd forge-gui-android
+          echo "${{ secrets.FORGE_KEYSTORE }}" > forge.keystore.asc
+          gpg -d --passphrase "${{ secrets.FORGE_KEYSTORE_PASSPHRASE }}" --batch forge.keystore.asc > forge.keystore
+          cd -
+          mkdir  -p ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          cd ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          curl -L -o android-maven-plugin-4.6.2.jar https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.jar
+          curl -L -o android-maven-plugin-4.6.2.pom https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.pom
+          cd -
+          mvn install -Dmaven.test.skip=true
+          mvn dependency:tree
+          
+
+      - name: Build/Install/Publish Desktop to GitHub Packages Apache Maven
+        if: ${{ github.event_name == 'workflow_dispatch' && !inputs.release_android }}
         run: |
           export DISPLAY=":1"
           Xvfb :1 -screen 0 800x600x8 &
-          mvn -U -B clean -P windows-linux install release:clean release:prepare release:perform -T 1C -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }}
+          export _JAVA_OPTIONS="-Xmx2g"
+          d=$(date +%m.%d)
+          # build only desktop and only try to move desktop files
+          mvn -U -B clean -P windows-linux install -DskipTests -Dskip.flatten=true -e -T 1C release:clean release:prepare release:perform
+          mkdir izpack
+          # move bz2 and jar from work dir to izpack dir
+          mv /home/runner/work/forge/forge/forge-installer/*/*.{bz2,jar} izpack/
+          # move desktop build.txt and version.txt to izpack
+          mv /home/runner/work/forge/forge/forge-gui-desktop/target/classes/*.txt izpack/
+          cd izpack
+          ls
+          echo "GIT_TAG=`echo $(git describe --tags --abbrev=0)`" >> $GITHUB_ENV
         env:
           GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Build/Install/Publish Desktop+Android to GitHub Packages Apache Maven
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.release_android }}
+        run: |
+          export DISPLAY=":1"
+          Xvfb :1 -screen 0 800x600x8 &
+          export _JAVA_OPTIONS="-Xmx2g"
+          d=$(date +%m.%d)
+          # build both desktop and android
+          mvn -U -B clean -P windows-linux,android-release-build install -e -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }} -Dandroid.sdk.path=/usr/local/lib/android/sdk -Dandroid.buildToolsVersion=35.0.0
+          mkdir izpack
+          # move bz2 and jar from work dir to izpack dir
+          mv /home/runner/work/forge/forge/forge-installer/*/*.{bz2,jar} izpack/
+          # move desktop build.txt and version.txt to izpack
+          mv /home/runner/work/forge/forge/forge-gui-desktop/target/classes/*.txt izpack/
+          # move android apk and assets.zip
+          mv /home/runner/work/forge/forge/forge-gui-android/target/*-signed-aligned.apk izpack/
+          mv /home/runner/work/forge/forge/forge-gui-android/target/assets.zip izpack/
+          cd izpack
+          ls
+          echo "GIT_TAG=`echo $(git describe --tags --abbrev=0)`" >> $GITHUB_ENV
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Upload snapshot to GitHub Prerelease
+        uses: ncipollo/release-action@v1
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: Release ${{ env.GIT_TAG }}
+          tag: ${{ env.GIT_TAG }}
+          artifacts: izpack/*
+          allowUpdates: true
+          removeArtifacts: true
+          makeLatest: true
+
+      - name: 🔧 Install XML tools
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libxml2-utils
+
+      - name: 🔼 Bump versionCode in root POM
+        id: bump_version
+        run: |
+          cd /home/runner/work/forge/forge/
+          
+          current_version=$(xmllint --xpath "//*[local-name()='versionCode']/text()" pom.xml)
+          echo "Current versionCode: $current_version"
+
+          IFS='.' read -r major minor patch <<< "${current_version}"
+          new_patch=$(printf "%02d" $((10#$patch + 1)))
+          new_version="${major}.${minor}.${new_patch}"
+
+          sed -i -E "s|<versionCode>.*</versionCode>|<versionCode>${new_version}</versionCode>|" pom.xml
+
+          echo "version_code=${new_version}" >> $GITHUB_OUTPUT
+          
+      - name: ♻️ Restore {revision} in child POMs
+        run: |
+          find . -name pom.xml ! -path "./pom.xml" | while read -r pom; do
+            sed -i -E 's|<version>2\.0+\.[0-9]+(-SNAPSHOT)?</version>|<version>${revision}</version>|' "$pom"
+          done
+
+      - name: 💾 Commit restored {revision}
+        run: |
+          # Add only pom.xml files
+          find . -name pom.xml -exec git add {} \;
+
+          # Commit if there are changes
+          if git diff --cached --quiet; then
+            echo "No pom.xml changes to commit."
+          else
+            git commit -m "Restore POM files for preparation of next release" || echo "No changes to commit"
+            git push
+          fi
+
+      - name: Send failure notification to Discord
+        if: failure() # This step runs only if the job fails
+        run: |
+          curl -X POST -H "Content-Type: application/json" \
+          -d "{\"content\": \"🔴 Release Build Failed in branch: \`${{ github.ref_name }}\` by \`${{ github.actor }}\`.\nCheck logs: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\"}" \
+          ${{ secrets.DISCORD_AUTOMATION_WEBHOOK }}

.github/workflows/publish-android.yml

@@ -20,10 +20,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 8
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: '8'
+          java-version: '17'
           distribution: 'temurin'
           cache: 'maven'
           server-id: cardforge-repo
@@ -31,20 +31,20 @@ jobs:
           server-password: ${{ secrets.FTP_PASSWORD }}
           settings-path: ${{ github.workspace }} # location for the settings.xml file
 
-      - name: Install old maven (3.6.3)
+      - name: Install old maven (3.8.1)
         run: |
-          curl -o apache-maven-3.6.3-bin.tar.gz https://archive.apache.org/dist/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.tar.gz
-          tar xf apache-maven-3.6.3-bin.tar.gz
-          export PATH=$PWD/apache-maven-3.6.3/bin:$PATH
-          export MAVEN_HOME=$PWD/apache-maven-3.6.3
+          curl -o apache-maven-3.8.1-bin.tar.gz https://archive.apache.org/dist/maven/maven-3/3.8.1/binaries/apache-maven-3.8.1-bin.tar.gz
+          tar xf apache-maven-3.8.1-bin.tar.gz
+          export PATH=$PWD/apache-maven-3.8.1/bin:$PATH
+          export MAVEN_HOME=$PWD/apache-maven-3.8.1
           mvn --version
           
       - name: Install android SDK
         uses: maxim-lobanov/setup-android-tools@v1
         with:
           packages: |
-            platforms;android-26
-            build-tools;30.0.3
+            platforms;android-35
+            build-tools;35.0.0
 
       - name: Install virtual framebuffer (if not available) to allow running GUI on a headless server
         run: |
@@ -71,11 +71,11 @@ jobs:
 
       - name: Install Android maven plugin
         run: |
-          mkdir  -p ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.1
-          cd ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.1
-          curl -L -o android-maven-plugin-4.6.1.jar https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.1/android-maven-plugin-4.6.1.jar
-          curl -L -o android-maven-plugin-4.6.1.pom https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.1/android-maven-plugin-4.6.1.pom
-          #mvn install:install-file -Dfile=android-maven-plugin-4.6.1.jar -DgroupId=com.simpligility.maven.plugins -DartifactId=android-maven-plugin -Dversion=4.6.1 -Dpackaging=jar
+          mkdir  -p ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          cd ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          curl -L -o android-maven-plugin-4.6.2.jar https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.jar
+          curl -L -o android-maven-plugin-4.6.2.pom https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.pom
+          #mvn install:install-file -Dfile=android-maven-plugin-4.6.2.jar -DgroupId=com.simpligility.maven.plugins -DartifactId=android-maven-plugin -Dversion=4.6.2 -Dpackaging=jar
           cd -
           mvn install -Dmaven.test.skip=true
           mvn dependency:tree
@@ -83,7 +83,7 @@ jobs:
       - name: Build/Install/Publish to GitHub Packages Apache Maven
         run: |
           export _JAVA_OPTIONS="-Xmx2g"
-          mvn -U -B -P android-release-build,android-release-sign,android-release-upload install -e -Dsign.keystore=forge.keystore -Dsign.alias=Forge -Dsign.storepass=${{ secrets.SIGN_STORE_PASS }} -Dsign.keypass=${{ secrets.SIGN_STORE_PASS }}  -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }} -Dandroid.sdk.path=/usr/local/lib/android/sdk -Dandroid.buildToolsVersion=30.0.3 -Dmaven.test.skip=true
+          mvn -U -B -P android-release-build,android-release-upload install -e -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }} -Dandroid.sdk.path=/usr/local/lib/android/sdk -Dandroid.buildToolsVersion=35.0.0 -Dmaven.test.skip=true
         env:
           GITHUB_TOKEN: ${{ github.token }}
 

.github/workflows/remove-stale-branches.yml

@@ -0,0 +1,19 @@
+name: Remove stale branches
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *" # Everday at midnight
+
+jobs:
+  remove-stale-branches:
+    if: github.repository_owner == 'Card-Forge'
+    name: Remove Stale Branches
+    runs-on: ubuntu-latest
+    steps:
+      - uses: fpicalausa/remove-stale-branches@v2.1.0
+        with:
+          dry-run: false # Check out the console output before setting this to false
+          ignore-unknown-authors: true
+          ignore-branches-with-open-prs: true
+          default-recipient: tehdiplomat

.github/workflows/snapshot-both-pc-android.yml

@@ -0,0 +1,132 @@
+name: Create Snapshot Desktop and Android
+
+on:
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: false
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '00 18 * * *'
+
+jobs:
+  build:
+    if: github.repository_owner == 'Card-Forge'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      deployments: write
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'maven'
+          server-id: cardforge-repo
+          server-username: ${{ secrets.FTP_USERNAME }}
+          server-password: ${{ secrets.FTP_PASSWORD }}
+          settings-path: ${{ github.workspace }} # location for the settings.xml file
+
+      - name: Install virtual framebuffer (if not available) to allow running GUI on a headless server
+        run: command -v Xvfb >/dev/null 2>&1 || { sudo apt update && sudo apt install -y xvfb; }
+
+      - name: Configure Git User
+        run: |
+          git config user.email "actions@github.com"
+          git config user.name "GitHub Actions"
+
+      - name: Install old maven (3.8.1)
+        run: |
+          curl -o apache-maven-3.8.1-bin.tar.gz https://archive.apache.org/dist/maven/maven-3/3.8.1/binaries/apache-maven-3.8.1-bin.tar.gz
+          tar xf apache-maven-3.8.1-bin.tar.gz
+          export PATH=$PWD/apache-maven-3.8.1/bin:$PATH
+          export MAVEN_HOME=$PWD/apache-maven-3.8.1
+          mvn --version
+          
+      - name: Set Up Android tools
+        run: |
+          JAVA_HOME=${JAVA_HOME_17_X64} ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --sdk_root=$ANDROID_SDK_ROOT --install "build-tools;35.0.0" "platform-tools" "platforms;android-35"
+     
+      - name: Extract Android keystore
+        run: |
+          ls
+          cd forge-gui-android
+          echo "${{ secrets.FORGE_KEYSTORE }}" > forge.keystore.asc
+          gpg -d --passphrase "${{ secrets.FORGE_KEYSTORE_PASSPHRASE }}" --batch forge.keystore.asc > forge.keystore
+          cd -
+
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+
+      - name: Install Android maven plugin
+        run: |
+          mkdir  -p ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          cd ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          curl -L -o android-maven-plugin-4.6.2.jar https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.jar
+          curl -L -o android-maven-plugin-4.6.2.pom https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.pom
+          #mvn install:install-file -Dfile=android-maven-plugin-4.6.2.jar -DgroupId=com.simpligility.maven.plugins -DartifactId=android-maven-plugin -Dversion=4.6.2 -Dpackaging=jar
+          cd -
+          mvn install -Dmaven.test.skip=true
+          mvn dependency:tree
+
+      - name: Build/Install/Publish to GitHub Packages Apache Maven
+        run: |
+          export DISPLAY=":1"
+          Xvfb :1 -screen 0 800x600x8 &
+          export _JAVA_OPTIONS="-Xmx2g"
+          d=$(date +%m.%d)
+          # build both desktop and android
+          mvn -U -B clean -P windows-linux,android-release-build install -e -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }} -Dandroid.sdk.path=/usr/local/lib/android/sdk -Dandroid.buildToolsVersion=35.0.0
+          mkdir izpack
+          # move bz2 and jar from work dir to izpack dir
+          mv /home/runner/work/forge/forge/forge-installer/*/*.{bz2,jar} izpack/
+          # move desktop build.txt and version.txt to izpack
+          mv /home/runner/work/forge/forge/forge-gui-desktop/target/classes/*.txt izpack/
+          # move android apk and assets.zip
+          mv /home/runner/work/forge/forge/forge-gui-android/target/*-signed-aligned.apk izpack/
+          mv /home/runner/work/forge/forge/forge-gui-android/target/assets.zip izpack/
+          cd izpack
+          # rename files and append date
+          for file in *.jar; do
+            bname="${file%.*}"
+            echo "file renamed to ${bname}-${d}.jar"
+            mv "${bname}.jar" "${bname}-${d}.jar"
+           done
+           for file in *.bz2; do
+            # remove .bz2
+            fname="${file%.*}"
+            # remove .tar
+            bname="${fname%.*}"
+            echo "file renamed to ${bname}-${d}.tar.bz2"
+            mv "${fname}.bz2" "${bname}-${d}.tar.bz2"
+          done
+          ls
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Upload snapshot to GitHub Prerelease
+        uses: ncipollo/release-action@v1
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: Daily Snapshot
+          tag: daily-snapshots
+          prerelease: true
+          artifacts: izpack/*
+          allowUpdates: true
+          removeArtifacts: true
+
+      - name: Send failure notification to Discord
+        if: failure() # This step runs only if the job fails
+        run: |
+          curl -X POST -H "Content-Type: application/json" \
+          -d "{\"content\": \"🔴 Snapshot Build Failed in branch: \`${{ github.ref_name }}\` by \`${{ github.actor }}\`.\nCheck logs: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\"}" \
+          ${{ secrets.DISCORD_AUTOMATION_WEBHOOK }}

.github/workflows/snapshots-android.yml

@@ -8,10 +8,11 @@ on:
           description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
           required: false
           default: false
-  schedule:
-    # * is a special character in YAML so you have to quote this string
-    - cron:  '00 19 * * *'
-          
+        #upload_package:
+        #  type: boolean
+        #  description: 'Upload the completed Android package'
+        #  required: false
+        #  default: true
 
 jobs:
   build:
@@ -24,10 +25,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 8
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: '8'
+          java-version: '17'
           distribution: 'temurin'
           cache: 'maven'
           server-id: cardforge-repo
@@ -35,19 +36,17 @@ jobs:
           server-password: ${{ secrets.FTP_PASSWORD }}
           settings-path: ${{ github.workspace }} # location for the settings.xml file
 
-      - name: Install old maven (3.6.3)
+      - name: Install old maven (3.8.1)
         run: |
-          curl -o apache-maven-3.6.3-bin.tar.gz https://archive.apache.org/dist/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.tar.gz
-          tar xf apache-maven-3.6.3-bin.tar.gz
-          export PATH=$PWD/apache-maven-3.6.3/bin:$PATH
-          export MAVEN_HOME=$PWD/apache-maven-3.6.3
+          curl -o apache-maven-3.8.1-bin.tar.gz https://archive.apache.org/dist/maven/maven-3/3.8.1/binaries/apache-maven-3.8.1-bin.tar.gz
+          tar xf apache-maven-3.8.1-bin.tar.gz
+          export PATH=$PWD/apache-maven-3.8.1/bin:$PATH
+          export MAVEN_HOME=$PWD/apache-maven-3.8.1
           mvn --version
           
       - name: Set Up Android tools
         run: |
-          JAVA_HOME=${JAVA_HOME_11_X64} ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --sdk_root=$ANDROID_SDK_ROOT "platform-tools"
-          JAVA_HOME=${JAVA_HOME_11_X64} ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --sdk_root=$ANDROID_SDK_ROOT --install "platforms;android-26"
-          JAVA_HOME=${JAVA_HOME_11_X64} ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --sdk_root=$ANDROID_SDK_ROOT --install "build-tools;30.0.3"
+          JAVA_HOME=${JAVA_HOME_17_X64} ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --sdk_root=$ANDROID_SDK_ROOT --install "build-tools;35.0.0" "platform-tools" "platforms;android-35"
 
       - name: Install virtual framebuffer (if not available) to allow running GUI on a headless server
         run: |
@@ -74,11 +73,11 @@ jobs:
 
       - name: Install Android maven plugin
         run: |
-          mkdir  -p ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.1
-          cd ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.1
-          curl -L -o android-maven-plugin-4.6.1.jar https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.1/android-maven-plugin-4.6.1.jar
-          curl -L -o android-maven-plugin-4.6.1.pom https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.1/android-maven-plugin-4.6.1.pom
-          #mvn install:install-file -Dfile=android-maven-plugin-4.6.1.jar -DgroupId=com.simpligility.maven.plugins -DartifactId=android-maven-plugin -Dversion=4.6.1 -Dpackaging=jar
+          mkdir  -p ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          cd ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          curl -L -o android-maven-plugin-4.6.2.jar https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.jar
+          curl -L -o android-maven-plugin-4.6.2.pom https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.pom
+          #mvn install:install-file -Dfile=android-maven-plugin-4.6.2.jar -DgroupId=com.simpligility.maven.plugins -DartifactId=android-maven-plugin -Dversion=4.6.2 -Dpackaging=jar
           cd -
           mvn install -Dmaven.test.skip=true
           mvn dependency:tree
@@ -86,40 +85,30 @@ jobs:
       - name: Build/Install/Publish to GitHub Packages Apache Maven
         run: |
           export _JAVA_OPTIONS="-Xmx2g"
-          d=$(date +%m-%d)
-          # Replace date in forge-gui-mobile/src/forge/Forge.java
-          sed -i -e "s/-SNAPSHOT/-SNAPSHOT-${d}/g" forge-gui-mobile/src/forge/Forge.java
-          mvn -U -B -P android-release-build,android-release-sign install -e -Dsign.keystore=forge.keystore -Dsign.alias=Forge -Dsign.storepass=${{ secrets.SIGN_STORE_PASS }} -Dsign.keypass=${{ secrets.SIGN_STORE_PASS }}  -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }} -Dandroid.sdk.path=/usr/local/lib/android/sdk -Dandroid.buildToolsVersion=30.0.3 -Dmaven.test.skip=true
-          mkdir -p  forge-gui-android/target/upload
-          mv forge-gui-android/target/*-signed-aligned.apk forge-gui-android/target/upload/
-          mv forge-gui-android/target/assets.zip forge-gui-android/target/upload/
-          cd forge-gui-android/target/upload/
-          # Get the first APK file in the folder
+          mvn -U -B -P android-release-build install -e -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }} -Dandroid.sdk.path=/usr/local/lib/android/sdk -Dandroid.buildToolsVersion=35.0.0 -Dmaven.test.skip=true
+          mkdir upload
+          mv /home/runner/work/forge/forge/forge-gui-android/target/*-signed-aligned.apk upload/
+          mv /home/runner/work/forge/forge/forge-gui-android/target/assets.zip upload/
+          mv /home/runner/work/forge/forge/forge-gui-android/target/classes/assets/version.txt upload/
+          cd upload
           ls
-          apk_file=$(find . -maxdepth 1 -type f -name '*.apk' -print -quit)
-          
-          if [ -n "$apk_file" ]; then
-              version=$(echo "$apk_file" | grep -oP 'forge-android-\K\d+\.\d+\.\d+-SNAPSHOT' | sed 's/-signed-aligned.apk//')
-              echo "APK File: $apk_file"
-              echo "Version: $version"
-              mv *.apk "forge-android-$version-$d-signed-aligned.apk"
-
-              echo "$version-$d" > version.txt
-          else
-              echo "No .apk files found in the specified folder."
-          fi
-
-          cd -
-        
         env:
           GITHUB_TOKEN: ${{ github.token }}
 
       - name: 📂 Sync files
         uses: SamKirkland/FTP-Deploy-Action@v4.3.4
+        #if: ${{ inputs.upload_package }}
         with:
           server: ftp.cardforge.org
           username: ${{ secrets.FTP_USERNAME }}
           password: ${{ secrets.FTP_PASSWORD }}
-          local-dir: forge-gui-android/target/upload/
+          local-dir: upload/
           server-dir: downloads/dailysnapshots/
           state-name: .ftp-deploy-android-sync-state.json
+
+      - name: Send failure notification to Discord
+        if: failure() # This step runs only if the job fails
+        run: |
+          curl -X POST -H "Content-Type: application/json" \
+          -d "{\"content\": \"🔴 Android Snapshot Build Failed in branch: \`${{ github.ref_name }}\` by \`${{ github.actor }}\`.\nCheck logs: ${{ github.run_url }}\"}" \
+          ${{ secrets.DISCORD_AUTOMATION_WEBHOOK }}

.github/workflows/snapshots-pc.yml

@@ -8,9 +8,6 @@ on:
         description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
         required: false
         default: false
-  schedule:
-    # * is a special character in YAML so you have to quote this string
-    - cron:  '30 18 * * *'
 
 jobs:
   build:
@@ -23,10 +20,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: '11'
+          java-version: '17'
           distribution: 'temurin'
           cache: 'maven'
           server-id: cardforge-repo
@@ -45,7 +42,7 @@ jobs:
         run: |
           export DISPLAY=":1"
           Xvfb :1 -screen 0 800x600x8 &
-          mvn -U -B clean -P windows-linux install -T 1C -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }} 
+          mvn -U -B clean -P windows-linux install -T 1C -Dcardforge-repo.username=${{ secrets.FTP_USERNAME }} -Dcardforge-repo.password=${{ secrets.FTP_PASSWORD }}
         env:
           GITHUB_TOKEN: ${{ github.token }}
 
@@ -55,13 +52,27 @@ jobs:
 
       - name: Rename before upload
         run: |
-          mkdir tarball
-          # If this works just gotta figure out how to append datetime
-          mv /home/runner/.m2/repository/forge/forge-gui-desktop/*/*.bz2 tarball/
-          cd tarball
-          out="$(basename -s .tar.bz2 *)"
-          d=$(date +%m-%d)
-          mv "${out}.tar.bz2" "${out}-${d}.tar.bz2"
+          mkdir izpack
+          # move bz2 and jar from work dir to izpack dir
+          mv /home/runner/work/forge/forge/forge-installer/*/*.{bz2,jar} izpack/
+          # move desktop build.txt to izpack
+          mv /home/runner/work/forge/forge/forge-gui-desktop/target/classes/build.txt izpack/
+          cd izpack
+          d=$(date +%m.%d)
+          # rename files and append date
+          for file in *.jar; do
+            bname="${file%.*}"
+            echo "file renamed to ${bname}-${d}.jar"
+            mv "${bname}.jar" "${bname}-${d}.jar"
+          done
+          for file in *.bz2; do
+            # remove .bz2
+            fname="${file%.*}"
+            # remove .tar
+            bname="${fname%.*}"
+            echo "file renamed to ${bname}-${d}.tar.bz2"
+            mv "${fname}.bz2" "${bname}-${d}.tar.bz2"
+          done
 
       - name: 📂 Sync files
         uses: SamKirkland/FTP-Deploy-Action@v4.3.4
@@ -69,13 +80,16 @@ jobs:
           server: ftp.cardforge.org
           username: ${{ secrets.FTP_USERNAME }}
           password: ${{ secrets.FTP_PASSWORD }}
-          local-dir: tarball/
+          local-dir: izpack/
           server-dir: downloads/dailysnapshots/
           exclude: |
-            *.jar
             *.pom
             *.repositories
             *.xml
-            
 
-          
+      - name: Send failure notification to Discord
+        if: failure() # This step runs only if the job fails
+        run: |
+          curl -X POST -H "Content-Type: application/json" \
+          -d "{\"content\": \"🔴 Desktop Snapshot Build Failed in branch: \`${{ github.ref_name }}\` by \`${{ github.actor }}\`.\nCheck logs: ${{ github.run_url }}\"}" \
+          ${{ secrets.DISCORD_AUTOMATION_WEBHOOK }}

.github/workflows/sync-wiki.yml

@@ -0,0 +1,28 @@
+name: Publish wiki
+on:
+  push:
+    branches: [master]
+    paths:
+      - docs/**
+      - .github/workflows/sync-wiki.yml
+  workflow_dispatch:
+concurrency:
+  group: publish-wiki
+  cancel-in-progress: true
+permissions:
+  contents: write
+jobs:
+  publish-wiki:
+    if: github.repository_owner == 'Card-Forge'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: fix md links for Gollum
+        run: find ${{ github.workspace }}/docs/ -type f -name "*.md" -exec sed -i -E 's|(\[[^]]+]\()([^)]+\/)*([^).]+).md\)|\1\3)|g' '{}' \;
+      - name: fix image links for Gollum
+        run: find ${{ github.workspace }}/docs/ -type f -name "*.png" -exec mv '{}' ${{ github.workspace }}/docs/ \;
+      - uses: Andrew-Chen-Wang/github-wiki-action@v5
+        with:
+          path: docs
+          preprocess: false
+          strategy: init

.github/workflows/test-android-build.yml

@@ -0,0 +1,60 @@
+name: Test Android build
+
+on:
+  push:
+    paths: [ 'forge-gui-android/**' ]
+  pull_request:
+    paths: [ 'forge-gui-android/**' ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      deployments: write
+      packages: write
+    strategy:
+      matrix:
+        java: [ '17' ]
+    name: Test with Java ${{ matrix.Java }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: ${{ matrix.java }}
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Install old maven (3.8.1)
+        run: |
+          curl -o apache-maven-3.8.1-bin.tar.gz https://archive.apache.org/dist/maven/maven-3/3.8.1/binaries/apache-maven-3.8.1-bin.tar.gz
+          tar xf apache-maven-3.8.1-bin.tar.gz
+          export PATH=$PWD/apache-maven-3.8.1/bin:$PATH
+          export MAVEN_HOME=$PWD/apache-maven-3.8.1
+          mvn --version
+
+      - name: Set Up Android tools
+        run: |
+          JAVA_HOME=${JAVA_HOME_17_X64} ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --sdk_root=$ANDROID_SDK_ROOT --install "build-tools;35.0.0" "platform-tools" "platforms;android-35"
+
+      - name: Install Android maven plugin
+        run: |
+          mkdir  -p ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          cd ~/.m2/repository/com/simpligility/maven/plugins/android-maven-plugin/4.6.2
+          curl -L -o android-maven-plugin-4.6.2.jar https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.jar
+          curl -L -o android-maven-plugin-4.6.2.pom https://github.com/Card-Forge/android-maven-plugin/releases/download/4.6.2/android-maven-plugin-4.6.2.pom
+          #mvn install:install-file -Dfile=android-maven-plugin-4.6.2.jar -DgroupId=com.simpligility.maven.plugins -DartifactId=android-maven-plugin -Dversion=4.6.2 -Dpackaging=jar
+          cd -
+          mvn install -Dmaven.test.skip=true
+          mvn dependency:tree
+
+      - name: Install virtual framebuffer (if not available) to allow running GUI on a headless server
+        run: command -v Xvfb >/dev/null 2>&1 || { sudo apt update && sudo apt install -y xvfb; }
+
+      - name: Run build in virtual framebuffer
+        run: |
+          export DISPLAY=":1"
+          Xvfb :1 -screen 0 800x600x8 &
+          mvn -U -B -P android-test-build verify -e -T 1C -Dandroid.sdk.path=$ANDROID_SDK_ROOT -Dandroid.buildToolsVersion=35.0.0 -Dmaven.test.skip=true

.github/workflows/test-build.yaml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [ '8', '11' ]
+        java: ['17', '21']
     name: Test with Java ${{ matrix.Java }}
     steps:
       - uses: actions/checkout@v3
@@ -26,4 +26,4 @@ jobs:
         run: |
           export DISPLAY=":1"
           Xvfb :1 -screen 0 800x600x8 &
-          mvn -U -B clean -P windows-linux test
+          mvn -U -B clean test

.github/workflows/test-maven-settings.yml

@@ -14,10 +14,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    - name: Set up JDK 11
+    - name: Set up JDK 17
       uses: actions/setup-java@v3
       with:
-        java-version: '11'
+        java-version: '17'
         distribution: 'temurin'
         cache: 'maven'
         server-id: cardforge-repo

.gitignore

@@ -12,6 +12,7 @@
 .settings
 .classpath
 .project
+.checkstyle
 
 # Ignore VS Code config files
 
@@ -24,6 +25,8 @@
 
 nbactions.xml
 
+# Ignore flattened pom
+.flattened-pom.xml
 
 # Ignore binaries, temp files and test output, everywhere
 
@@ -63,6 +66,9 @@ forge-gui-mobile-dev/testAssets
 
 forge-gui/res/cardsfolder/*.bat
 
+# Generated changelog file
+forge-gui/release-files/CHANGES.txt
+
 forge-gui/res/PerSetTrackingResults
 forge-gui/res/decks
 forge-gui/res/layouts
@@ -84,3 +90,7 @@ forge-gui/tools/PerSetTrackingResults
 *.tiled-session
 /forge-gui/res/adventure/*.tiled-project
 /forge-gui/res/adventure/*.tiled-session
+
+# Ignore python temporaries
+__pycache__
+*.pyc

.gitlab/issue_templates/Bug.md

@@ -1,33 +0,0 @@
-Summary
-
-(Summarize the bug encountered concisely)
-
-
-Steps to reproduce
-
-(How one can reproduce the issue - this is very important. Specific cards and specific actions especially)
-
-
-Which version of Forge are you on (Release, Snapshot? Desktop, Android?)
-
-
-What is the current bug behavior?
-
-(What actually happens)
-
-
-What is the expected correct behavior?
-
-(What you should see instead)
-
-
-Relevant logs and/or screenshots
-
-(Paste/Attach your game.log from the crash - please use code blocks (```)) Also, provide screenshots of the current state.
-
-
-Possible fixes
-
-(If you can, link to the line of code that might be responsible for the problem)
-
-/label ~needs-investigation

.gitlab/issue_templates/Feature.md

@@ -1,15 +0,0 @@
-Summary
-
-(Summarize the feature you wish concisely)
-
-
-Example screenshots
-
-(If this is a UI change, please provide an example screenshot of how this feature might work)
-
-
-Feature type
-
-(Where in Forge does this belong? e.g. Quest Mode, Deck Editor, Limited, Constructed, etc.)
-
-/label ~feature request

.mvn/local-settings.xml

@@ -1,18 +1,6 @@
-<!--
-    Derived from: https://stackoverflow.com/a/67002852
--->
 <settings xmlns="http://maven.apache.org/SETTINGS/1.2.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 http://maven.apache.org/xsd/settings-1.2.0.xsd">
-    <mirrors>
-        <mirror>
-            <id>4thline-repo-http-unblocker</id>
-            <mirrorOf>4thline-repo</mirrorOf>
-            <name></name>
-            <url>http://4thline.org/m2</url>
-        </mirror>
-    </mirrors>
-
     <servers>
         <server>
             <id>cardforge-repo</id>
@@ -20,4 +8,4 @@
             <password>${cardforge-repo.password}</password>
         </server>
     </servers>
-</settings>
+</settings>

CONTRIBUTING.md

@@ -0,0 +1,195 @@
+# Contributing to Forge
+
+[Official repo](https://github.com/Card-Forge/forge.git).
+
+Dev instructions here: [Getting Started](https://github.com/Card-Forge/forge/wiki) (Somewhat outdated)
+
+## Requirements / Tools
+
+- your favourite Java IDE (IntelliJ, Eclipse, VSCodium, Emacs, Vi...)
+- Java JDK 17 or later
+- Git
+- Git client (optional)
+- Maven
+- GitHub account
+- Libgdx (optional: familiarity with this library is helpful for mobile platform development)
+- Android SDK (optional: for Android releases)
+- RoboVM (optional: for iOS releases) (TBD: Current status of support by libgdx)
+
+## Project Quick Setup
+
+- Login into GitHub with your user account and fork the project.
+
+- Clone your forked project to your local machine
+
+- Go to the project location on your machine. Run Maven to download all dependencies and build a snapshot. Example for Windows & Linux: `mvn -U -B clean -P windows-linux install`
+
+## IntelliJ
+
+IntelliJ is the recommended IDE for Forge development. Quick start guide for [setting up the Forge project within IntelliJ](https://github.com/Card-Forge/forge/wiki/IntelliJ-setup).
+
+## Eclipse
+
+Eclipse includes Maven integration so a separate install is not necessary. For other IDEs, your mileage may vary.
+At this time, Eclipse is not the recommended IDE for Forge development.
+
+### Project Setup
+
+- Follow the instructions for cloning from GitHub. You'll need to setup an account and your SSH key.
+
+  If you are on a Windows machine you can use Putty with TortoiseGit for SSH keys. Run puttygen.exe to generate the key -- save the private key and export
+  the OpenSSH public key. If you just leave the dialog open, you can copy and paste the key from it to your GitHub profile under
+  "SSH keys". Run pageant.exe and add the private key generated earlier. TortoiseGit will use this for accessing GitHub.
+
+- Fork the Forge git repo to your GitHub account.
+
+- Clone your forked repo to your local machine.
+
+- Make sure the Java SDK is installed -- not just the JRE. Java 17 or newer required. If you execute `java -version` at the shell or command prompt, it should report version 17 or later.
+
+- Install Eclipse 2021-12 or later for Java. Launch it.
+
+- Create a workspace. Go to the workbench. Right-click inside of Package Explorer > Import... > Maven > Existing Maven Projects > Navigate to root path of the local forge repo and
+  ensure everything is checked > Finish.
+
+- Let Eclipse run through building the project. You may be prompted for resolving any missing Maven plugins -- accept the ones offered. You may see errors appear in the "Problems" tab. These should
+  be automatically resolved as plug-ins are installed and Eclipse continues the build process. If this is the first time for some plug-in installs, Eclipse may prompt you to restart. Do so. Be patient
+  for this first time through.
+
+- Once everything builds, all errors should disappear. You can now advance to Project launch.
+
+### Project Launch
+
+#### Desktop
+
+This is the standard configuration used for releasing to Windows / Linux / MacOS.
+
+- Right-click on forge-gui-desktop > Run As... > Java Application > "Main - forge.view" > Ok
+
+- The familiar Forge splash screen, etc. should appear. Enjoy!
+
+#### Mobile (Desktop dev)
+
+This is the configuration used for doing mobile development using the Windows / Linux / MacOS front-end. Knowledge of libgdx is helpful here.
+
+- Right-click on forge-gui-mobile-dev > Run As... > Java Application > "Main - forge.app" > Ok.
+
+- A view similar to a mobile phone should appear. Enjoy!
+
+### Eclipse / Android SDK Integration
+
+Google no longer supports Android SDK releases for Eclipse. use IntelliJ.
+
+#### Android SDK
+
+TBD
+
+##### Windows
+
+TBD
+
+##### Linux / Mac OSX
+
+TBD
+
+#### Android Plugin for Eclipse
+
+TBD
+
+#### Android Platform
+
+In Intellij, if the SDK Manager is not already running, go to Tools > Android > Android SDK Manager. Install the following options / versions:
+
+- Android SDK Build-tools 35.0.0
+- Android 15 (API 35) SDK Platform
+
+#### Proguard update
+
+Standalone Proguard 7.6.0 is included with the project (proguard.jar) under forge-gui-android > tools and supports up to Java 23 (latest android uses Java 17).
+
+#### Android Build
+
+TBD
+
+#### Android Deploy
+
+TBD
+
+#### Android Debugging
+
+TBD
+
+### Windows / Linux SNAPSHOT build
+
+SNAPSHOT builds can be built via the Maven integration in Eclipse.
+
+1. Create a Maven build for the forge top-level project. Right-click on the forge project. Run as.. > Maven build...
+
+   - On the Main tab, set Goals: clean install, set Profiles: windows-linux
+
+2. Run forge Maven build. If everything built, you should see "BUILD SUCCESS" in the Console View.
+
+The resulting snapshot will be found at: forge-gui-desktop/target/forge-gui-desktop-[version]-SNAPSHOT
+
+## Card Scripting
+
+Visit [this page](https://github.com/Card-Forge/forge/wiki/Card-scripting-API) for information on scripting.
+
+Card scripting resources are found in the forge-gui/res/ path.
+
+## General Notes
+
+### Project Hierarchy
+
+Forge is divided into 4 primary projects with additional projects that target specific platform releases. The primary projects are:
+
+- forge-ai
+- forge-core
+- forge-game
+- forge-gui
+
+The platform-specific projects are:
+
+- forge-gui-android
+- forge-gui-desktop
+- forge-gui-ios
+- forge-gui-mobile
+- forge-gui-mobile-dev
+
+#### forge-ai
+
+The forge-ai project contains the computer opponent logic for gameplay. It includes decision-making algorithms for specific abilities, cards and turn phases.
+
+#### forge-core
+
+The forge-core project contains the core game engine, card mechanics, rules engine, and fundamental game logic. It includes the implementation of Magic: The Gathering rules, card interactions, and the game state management system.
+
+#### forge-game
+
+The forge-game project handles the game session management, player interactions, and game flow control. It includes implementations for multiplayer support, game modes, matchmaking, and game state persistence. This module bridges the core game engine with the user interface and networking components.
+
+#### forge-gui
+
+The forge-gui project contains the user interface components and rendering logic for the game. It includes the main game window, card displays, player interactions, and the scripting resource definitions in the res/ path.
+
+#### forge-gui-android
+
+Libgdx-based backend targeting Android. Requires Android SDK and relies on forge-gui-mobile for GUI logic.
+
+#### forge-gui-desktop
+
+Java Swing based GUI targeting desktop machines.
+
+Screen layout and game logic revolving around the GUI is found here. For example, the overlay arrows (when enabled) that indicate attackers and blockers, or the targets of the stack are defined and drawn by this.
+
+#### forge-gui-ios
+
+Libgdx-based backend targeting iOS. Relies on forge-gui-mobile for GUI logic.
+
+#### forge-gui-mobile
+
+Mobile GUI game logic utilizing [libgdx](https://libgdx.badlogicgames.com/) library. Screen layout and game logic revolving around the GUI for the mobile platforms is found here.
+
+#### forge-gui-mobile-dev
+
+Libgdx backend for desktop development for mobile backends. Utilizes LWJGL. Relies on forge-gui-mobile for GUI logic.

README.md

@@ -1,230 +1,105 @@
-# Forge
+# ⚔️  Forge: The Magic: The Gathering Rules Engine
 
-[Official repo](https://github.com/Card-Forge/forge.git).
-
-Dev instructions here: [Getting Started](https://github.com/Card-Forge/forge/wiki) (Somewhat outdated)
-
-[Discord channel](https://discord.gg/HcPJNyD66a)
+Join the **Forge community** on [Discord](https://discord.gg/HcPJNyD66a)!
 
 [![Test build](https://github.com/Card-Forge/forge/actions/workflows/test-build.yaml/badge.svg)](https://github.com/Card-Forge/forge/actions/workflows/test-build.yaml)
 
-## Requirements / Tools
+---
 
-- you favourite Java IDE (IntelliJ, Eclipse, VSCodium, Emacs, Vi...)
-- Java JDK 8 or later (some IDEs such as Eclipse require JDK11+, whereas the Android build currently only works with JDK8)
-- Git
-- Git client (optional)
-- Maven
-- GitHub account
-- Libgdx (optional: familiarity with this library is helpful for mobile platform development)
-- Android SDK (optional: for Android releases)
-- RoboVM (optional: for iOS releases) (TBD: Current status of support by libgdx)
+## ✨ Introduction
 
-## Project Quick Setup
+**Forge** is a dynamic and open-source **Rules Engine** tailored for **Magic: The Gathering** enthusiasts. Developed by a community of passionate programmers, Forge allows players to explore the rich universe of MTG through a flexible, engaging platform. 
 
-- Login into GitHub with your user account and fork the project.
+**Note:** Forge operates independently and is not affiliated with Wizards of the Coast.
 
-- Clone your forked project to your local machine
+---
 
-- Go to the project location on your machine.  Run Maven to download all dependencies and build a snapshot.  Example for Windows & Linux: `mvn -U -B clean -P windows-linux install`
+## 🌟 Key Features
 
-## Eclipse
+- **🌐 Cross-Platform Support:** Play on **Windows, Mac, Linux,** and **Android**.
+- **🔧 Extensible Architecture:** Built in **Java**, Forge encourages developers to contribute by adding features and cards.
+- **🎮 Versatile Gameplay:** Dive into single-player modes or challenge opponents online!
 
-Eclipse includes Maven integration so a separate install is not necessary.  For other IDEs, your mileage may vary.
+---
 
-### Project Setup
+## 🛠️ Installation Guide
 
-- Follow the instructions for cloning from GitHub.  You'll need to setup an account and your SSH key.
+### 📥 Desktop Installation
+1. **Latest Releases:** Download the latest version [here](https://github.com/Card-Forge/forge/releases/latest).
+2. **Snapshot Build:** For the latest development version, grab the `forge-gui-desktop` tarball from our [Snapshot Build](https://github.com/Card-Forge/forge/releases/tag/daily-snapshots).
+   - **Tip:** Extract to a new folder to prevent version conflicts.
+3. **User Data Management:** Previous players’ data is preserved during upgrades.
+4. **Java Requirement:** Ensure you have **Java 17 or later** installed.
 
-  If you are on a Windows machine you can use Putty with TortoiseGit for SSH keys.  Run puttygen.exe to generate the key -- save the private key and export
-  the OpenSSH public key.  If you just leave the dialog open, you can copy and paste the key from it to your GitHub profile under
-  "SSH keys".  Run pageant.exe and add the private key generated earlier.  TortoiseGit will use this for accessing GitHub.
+### 📱 Android Installation
+- _(Note: **Android 11** is the minimum requirements with at least **6GB RAM** to run smoothly. You need to enable **"Install unknown apps"** for Forge to initialize and update itself)_
+- Download the **APK** from the [Snapshot Build](https://github.com/Card-Forge/forge/releases/tag/daily-snapshots). On the first launch, Forge will automatically download all necessary assets.
 
-- Fork the Forge git repo to your GitHub account.
+---
 
-- Clone your forked repo to your local machine.
+## 🎮 Modes of Play
 
-- Make sure the Java SDK is installed -- not just the JRE.  Java 8 or newer required.  If you execute `java -version` at the shell or command prompt, it should report version 1.8 or later.
+Forge offers various exciting gameplay options:
 
-- Install Eclipse 2018-12 or later for Java.  Launch it.
+### 🌍 Adventure Mode
+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.
 
-- Create a workspace.  Go to the workbench.  Right-click inside of Package Explorer > Import... > Maven > Existing Maven Projects > Navigate to root path of the local forge repo and
-  ensure everything is checked > Finish.
+<img width="1282" height="752" alt="Shandalar World" src="https://github.com/user-attachments/assets/9af31471-d688-442f-9418-9807d8635b72" />
 
-- Let Eclipse run through building the project.  You may be prompted for resolving any missing Maven plugins -- accept the ones offered.  You may see errors appear in the "Problems" tab.  These should
-  be automatically resolved as plug-ins are installed and Eclipse continues the build process.  If this is the first time for some plug-in installs, Eclipse may prompt you to restart.  Do so.  Be patient
-  for this first time through.
+### 🔍 Quest Modes
+Engage in focused gameplay without the overworld exploration—perfect for quick sessions!
 
-- Once everything builds, all errors should disappear.  You can now advance to Project launch.
+<img width="1282" height="752" alt="Quest Duels" src="https://github.com/user-attachments/assets/b9613b1c-e8c3-4320-8044-6922c519aad4" />
 
-### Project Launch
+### 🤖 AI Formats
+Test your skills against AI in multiple formats:
+- **Sealed**
+- **Draft**
+- **Commander**
+- **Cube**
 
-#### Desktop
+For comprehensive gameplay instructions, visit our [Gameplay Guide](https://github.com/Card-Forge/forge/wiki/Gameplay-Guide).
 
-This is the standard configuration used for releasing to Windows / Linux / MacOS.
+<img width="1282" height="752" alt="Sealed" src="https://github.com/user-attachments/assets/ae603dbd-4421-4753-a333-87cb0a28d772" />
 
-- Right-click on forge-gui-desktop > Run As... > Java Application > "Main - forge.view" > Ok
+---
 
-- The familiar Forge splash screen, etc. should appear.  Enjoy!
+## 💬 Support & Community
 
-#### Mobile (Desktop dev)
+Need help? Join our vibrant Discord community! 
+- 📜 Read the **#rules** and explore the **FAQ**.
+- ❓ Ask your questions in the **#help** channel for assistance.
 
-This is the configuration used for doing mobile development using the Windows / Linux / MacOS front-end.  Knowledge of libgdx is helpful here.
+---
 
-- Right-click on forge-gui-mobile-dev > Run As... > Java Application > "Main - forge.app" > Ok.
+## 🤝 Contributing to Forge
 
-- A view similar to a mobile phone should appear.  Enjoy!
+We love community contributions! Interested in helping? Check out our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started.
 
-### Eclipse / Android SDK Integration
+---
 
-Google no longer supports Android SDK releases for Eclipse.  That said, it is still possible to build and debug Android platforms.
+## ℹ️ About Forge
 
-#### Android SDK
+Forge aims to deliver an immersive and customizable Magic: The Gathering experience for fans around the world. 
 
-Reference SO for obtaining a specific release: https://stackoverflow.com/questions/27043522/where-can-i-download-an-older-version-of-the-android-sdk
+### 📊 Repository Statistics
 
-##### Windows
+| Metric         | Count                                                       |
+|----------------|-------------------------------------------------------------|
+| **⭐ Stars:**   | [![GitHub stars](https://img.shields.io/github/stars/Card-Forge/forge?style=flat-square)](https://github.com/Card-Forge/forge/stargazers) |
+| **🍴 Forks:**   | [![GitHub forks](https://img.shields.io/github/forks/Card-Forge/forge?style=flat-square)](https://github.com/Card-Forge/forge/network) |
+| **👥 Contributors:** | [![GitHub contributors](https://img.shields.io/github/contributors/Card-Forge/forge?style=flat-square)](https://github.com/Card-Forge/forge/graphs/contributors) |
 
-Download the following archived version of the Android SDK: http://dl-ssl.google.com/android/repository/tools_r25.2.3-windows.zip. Install it somewhere on your machine.  This is referenced
-in the following instructions as your 'Android SDK Install' path.
+---
 
-##### Linux / Mac OSX
-
-TBD
-
-#### Android Plugin for Eclipse
-
-Google's last plugin release does not work completely with target's running Android 7.0 or later.  Download the ADT-24.2.0-20160729.zip plugin
-from: https://github.com/khaledev/ADT/releases
-
-In Eclipse go to: Help > Install New Software... > Add > Name: ADT Update, Click on the "Archive:" button and navigate to the downloaded ADT-24.2.0-20160729.zip file > Add.  Install all "Developer Tools".  Eclipse
-should restart and prompt you to run the SDK Manager.  Launch it and continue to the next steps below.
-
-#### Android Platform
-
-In Eclipse, if the SDK Manager is not already running, go to Window > Android SDK Manager.  Install the following options / versions:
-
-- Android SDK Build-tools 26.0.1
-- Android 8.0.0 (API 26) SDK Platform
-- Google USB Driver (in case your phone is not detected by ADB)
-
-Note that this will populate additional tools in the Android SDK install path extracted above.
-
-#### Proguard update
-
-The Proguard included with the Android SDK Build-tools is outdated and does not work with Java 1.8.  Download Proguard 6.0.3 or later (last tested with 7.0.1) from https://github.com/Guardsquare/proguard
-- Go to the Android SDK install path.  Rename the tools/proguard/ path to tools/proguard-4.7/.
-
-- Extract your Proguard version to the Android SDK install path under tools/.  You will need to either rename the dir proguard-<your-version> to proguard/ or, if your filesystem supports it, use a symbolic link (the later is highly recommended), such as `ln -s proguard proguard-<your-version>`.
-
-#### Android Build
-
-The Eclipse plug-ins do NOT support building things for Android.  They do however allow you to use the debugger so you can still set breakpoints and trace
-things out.  The steps below show how to generate a debug Android build.
-
-1) Create a Maven build for the forge top-level project.  Right-click on the forge project.  Run as.. > Maven build...
-   - On the Main tab, set Goals: clean install
-
-2) Run forge Maven build.  If everything built, you should see "BUILD SUCCESS" in the Console View.
-
-3) Right-click on the forge-gui-android project.  Run as.. > Maven build...
-
-   - On the Main tab, set Goals: install, Profiles: android-debug
-   - On the Environment tab, you may need to define the variable ANDROID_HOME with the value containing the path to your Android SDK installation.  For example, Variable: ANDROID_HOME, Value: Your Android SDK install path here.
-
-4) Run the forge-gui-android Maven build.  This may take a few minutes.  If everything worked, you should see "BUILD SUCCESS" in the Console View.
-
-Assuming you got this far, you should have an Android forge-android-[version].apk in the forge-gui-android/target path.
-
-#### Android Deploy
-
-You'll need to have the Android SDK install path platform-tools/ path in your command search path to easily deploy builds.
-
-- Open a command prompt.  Navigate to the forge-gui-android/target/ path.
-
-- Connect your Android device to your dev machine.
-
-- Ensure the device is visible using `adb devices`
-
-- Remove the old Forge install if present: `adb uninstall forge.app`
-
-- Install the new apk: `adb install forge-android-[version].apk`
-
-#### Android Debugging
-
-Assuming the apk is installed, launch it from the device.
-
-In Eclipse, launch the DDMS.  Window > Perspective > Open Perspective > Other... > DDMS.  You should see the forge app in the list.  Highlight the app, click on the green debug button and a
-green debug button should appear next to the app's name.  You can now set breakpoints and step through the source code.
-
-### Windows / Linux SNAPSHOT build
-
-SNAPSHOT builds can be built via the Maven integration in Eclipse.
-
-1) Create a Maven build for the forge top-level project.  Right-click on the forge project.  Run as.. > Maven build...
-   - On the Main tab, set Goals: clean install, set Profiles: windows-linux
-
-2) Run forge Maven build.  If everything built, you should see "BUILD SUCCESS" in the Console View.
-
-The resulting snapshot will be found at: forge-gui-desktop/target/forge-gui-desktop-[version]-SNAPSHOT
-
-## IntelliJ
-
-Quick start guide for [setting up the Forge project within IntelliJ](https://github.com/Card-Forge/forge/wiki/IntelliJ-setup).
-
-## Card Scripting
-
-Visit [this page](https://github.com/Card-Forge/forge/wiki/Card-scripting-API) for information on scripting.
-
-Card scripting resources are found in the forge-gui/res/ path.
-
-## General Notes
-
-### Project Hierarchy
-
-Forge is divided into 4 primary projects with additional projects that target specific platform releases.  The primary projects are:
-
-- forge-ai
-- forge-core
-- forge-game
-- forge-gui
-
-The platform-specific projects are:
-
-- forge-gui-android
-- forge-gui-desktop
-- forge-gui-ios
-- forge-gui-mobile
-- forge-gui-mobile-dev
-
-#### forge-ai
-
-#### forge-core
-
-#### forge-game
-
-#### forge-gui
-
-The forge-gui project includes the scripting resource definitions in the res/ path.
-
-#### forge-gui-android
-
-Libgdx-based backend targeting Android.  Requires Android SDK and relies on forge-gui-mobile for GUI logic.
-
-#### forge-gui-desktop
-
-Java Swing based GUI targeting desktop machines.
-
-Screen layout and game logic revolving around the GUI is found here.  For example, the overlay arrows (when enabled) that indicate attackers and blockers, or the targets of the stack are defined and drawn by this.
-
-#### forge-gui-ios
-
-Libgdx-based backend targeting iOS.  Relies on forge-gui-mobile for GUI logic.
-
-#### forge-gui-mobile
-
-Mobile GUI game logic utilizing [libgdx](https://libgdx.badlogicgames.com/) library.  Screen layout and game logic revolving around the GUI for the mobile platforms is found here.
-
-#### forge-gui-mobile-dev
-
-Libgdx backend for desktop development for mobile backends.  Utilizes LWJGL.  Relies on forge-gui-mobile for GUI logic.
+**📄 License:** [GPL-3.0](LICENSE)
+<div align="center" style="display: flex; align-items: center; justify-content: center;">
+    <div style="margin-left: auto;">
+        <a href="#top">
+            <img src="https://img.shields.io/badge/Back%20to%20Top-000000?style=for-the-badge&logo=github&logoColor=white" alt="Back to Top">
+        </a>
+    </div>
+</div>

adventure-editor/pom.xml

@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>forge</artifactId>
+        <groupId>forge</groupId>
+        <version>${revision}</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>adventure-editor</artifactId>
+    <packaging>jar</packaging>
+    <name>Adventure Editor</name>
+
+    <build>
+        <sourceDirectory>src/main/java</sourceDirectory>
+        <resources>
+            <resource>
+                <directory>${project.basedir}</directory>
+                <includes>
+                    <include>**/gear.gif</include>
+                </includes>
+            </resource>
+        </resources>
+        <finalName>adventure-editor</finalName>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>17</source>
+                    <target>17</target>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>com.google.code.maven-replacer-plugin</groupId>
+                <artifactId>replacer</artifactId>
+                <version>1.5.3</version>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>replace</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <basedir>${basedir}/${configSourceDirectory}</basedir>
+                    <filesToInclude>adventure-editor.sh, adventure-editor.command, adventure-editor.cmd</filesToInclude>
+                    <outputBasedir>${project.build.directory}</outputBasedir>
+                    <outputDir>.</outputDir>
+                    <regex>false</regex>
+                    <replacements>
+                        <replacement>
+                            <token>$project.build.finalName$</token>
+                            <value>${project.build.finalName}-jar-with-dependencies.jar</value>
+                        </replacement>
+                    </replacements>
+                </configuration>
+            </plugin>
+            <plugin>
+
+                <artifactId>maven-assembly-plugin</artifactId>
+                <configuration>
+                    <attach>false</attach>
+                    <descriptorRefs>
+                        <descriptorRef>jar-with-dependencies</descriptorRef>
+                    </descriptorRefs>
+                    <archive>
+                        <manifest>
+                            <mainClass>forge.adventure.Main</mainClass>
+                            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+                        </manifest>
+                        <manifestEntries>
+                            <SplashScreen-Image>splash/gear.gif</SplashScreen-Image>
+                        </manifestEntries>
+                    </archive>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>make-assembly</id>
+                        <!-- this is used for inheritance merges -->
+                        <phase>package</phase>
+                        <!-- bind to the packaging phase -->
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>forge</groupId>
+            <artifactId>forge-gui</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>forge</groupId>
+            <artifactId>forge-gui-mobile</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>26.0.1</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
+
+    <properties>
+        <maven.compiler.source>17</maven.compiler.source>
+        <maven.compiler.target>17</maven.compiler.target>
+    </properties>
+
+</project>

adventure-editor/src/main/config/adventure-editor.cmd

@@ -0,0 +1,24 @@
+@echo off
+
+pushd %~dp0
+
+java -version 1>nul 2>nul || (
+   echo no java installed
+   popd
+   exit /b 2
+)
+for /f tokens^=2^ delims^=.-_^+^" %%j in ('java -fullversion 2^>^&1') do set "jver=%%j"
+
+if %jver% LEQ 16 (
+   echo unsupported java
+   popd
+   exit /b 2
+)
+
+if %jver% GEQ 17 (
+  java -Xmx4096m -Dfile.encoding=UTF-8 -jar $project.build.finalName$
+  popd
+  exit /b 0
+)
+
+popd

adventure-editor/src/main/java/forge/adventure/Main.java

@@ -0,0 +1,21 @@
+package forge.adventure;
+
+import forge.GuiMobile;
+import forge.adventure.editor.EditorMainWindow;
+import forge.adventure.util.Config;
+import forge.gui.GuiBase;
+
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+/**
+ * Main entry point
+ */
+public class Main {
+
+    public static void main(String[] args) {
+        GuiBase.setInterface(new GuiMobile(Files.exists(Paths.get("./res"))?"./":"../forge-gui/"));
+        GuiBase.setDeviceInfo(null, 0, 0, System.getProperty("user.home") + "/Downloads/");
+        new EditorMainWindow(Config.instance());
+    }
+}

adventure-editor/src/main/java/forge/adventure/editor/ActionEdit.java

@@ -2,7 +2,9 @@ package forge.adventure.editor;
 
 import forge.adventure.data.DialogData;
 
-import javax.swing.*;
+import javax.swing.JSpinner;
+import javax.swing.JTextField;
+import javax.swing.SpinnerNumberModel;
 import javax.swing.event.ChangeEvent;
 import javax.swing.event.ChangeListener;
 
@@ -158,9 +160,9 @@ public class ActionEdit extends FormPanel {
         advanceQuestFlag.setText(currentData.advanceQuestFlag);
         advanceCharacterFlag.setText(currentData.advanceCharacterFlag);
 
-        battleWithActorID.setText("" + currentData.battleWithActorID);
-        activateObjectID.setText("" + currentData.battleWithActorID);
-        deleteMapObject.setText("" + currentData.deleteMapObject);
+        battleWithActorID.setText(String.valueOf(currentData.battleWithActorID));
+        activateObjectID.setText(String.valueOf(currentData.battleWithActorID));
+        deleteMapObject.setText(String.valueOf(currentData.deleteMapObject));
         setColorIdentity.setText(currentData.setColorIdentity);
         addLife.getModel().setValue(currentData.addLife);
         addReputation.getModel().setValue(currentData.addMapReputation);

adventure-editor/src/main/java/forge/adventure/editor/ActionEditor.java

@@ -0,0 +1,144 @@
+package forge.adventure.editor;
+
+import forge.adventure.data.DialogData;
+
+import javax.swing.DefaultListCellRenderer;
+import javax.swing.DefaultListModel;
+import javax.swing.JButton;
+import javax.swing.JComponent;
+import javax.swing.JLabel;
+import javax.swing.JList;
+import javax.swing.JToolBar;
+import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
+import java.awt.BorderLayout;
+import java.awt.Component;
+import java.awt.event.ActionListener;
+
+/**
+ * Editor class to edit configuration, maybe moved or removed
+ */
+public class ActionEditor extends JComponent {
+    DefaultListModel<DialogData.ActionData> model = new DefaultListModel<>();
+    JList<DialogData.ActionData> list = new JList<>(model);
+    JToolBar toolBar = new JToolBar("toolbar");
+    ActionEdit edit = new ActionEdit();
+    boolean updating;
+
+
+    public class RewardDataRenderer extends DefaultListCellRenderer {
+        @Override
+        public Component getListCellRendererComponent(
+                JList list, Object value, int index,
+                boolean isSelected, boolean cellHasFocus) {
+            JLabel label = (JLabel) super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
+            if (!(value instanceof DialogData.ActionData))
+                return label;
+            /*DialogData.ActionData action=(DialogData.ActionData) value;
+            StringBuilder builder=new StringBuilder();
+            if(action.type==null||action.type.isEmpty())
+                builder.append("Action");
+            else
+                builder.append(action.type);*/
+            label.setText("Action");
+            return label;
+        }
+    }
+
+    public void addButton(String name, ActionListener action) {
+        JButton newButton = new JButton(name);
+        newButton.addActionListener(action);
+        toolBar.add(newButton);
+
+    }
+
+    public ActionEditor() {
+
+        list.setCellRenderer(new RewardDataRenderer());
+        list.addListSelectionListener(e -> ActionEditor.this.updateEdit());
+        addButton("add", e -> ActionEditor.this.addAction());
+        addButton("remove", e -> ActionEditor.this.remove());
+        addButton("copy", e -> ActionEditor.this.copy());
+        BorderLayout layout = new BorderLayout();
+        setLayout(layout);
+        add(list, BorderLayout.LINE_START);
+        add(toolBar, BorderLayout.PAGE_START);
+        add(edit, BorderLayout.CENTER);
+
+
+        edit.addChangeListener(e -> emitChanged());
+    }
+
+    protected void emitChanged() {
+        if (updating)
+            return;
+        ChangeListener[] listeners = listenerList.getListeners(ChangeListener.class);
+        if (listeners != null && listeners.length > 0) {
+            ChangeEvent evt = new ChangeEvent(this);
+            for (ChangeListener listener : listeners) {
+                listener.stateChanged(evt);
+            }
+        }
+    }
+
+    private void copy() {
+
+        int selected = list.getSelectedIndex();
+        if (selected < 0)
+            return;
+        DialogData.ActionData data = new DialogData.ActionData(model.get(selected));
+        model.add(model.size(), data);
+    }
+
+    private void updateEdit() {
+
+        int selected = list.getSelectedIndex();
+        if (selected < 0)
+            return;
+        edit.setCurrentAction(model.get(selected));
+    }
+
+    void addAction() {
+        DialogData.ActionData data = new DialogData.ActionData();
+        model.add(model.size(), data);
+    }
+
+    void remove() {
+        int selected = list.getSelectedIndex();
+        if (selected < 0)
+            return;
+        model.remove(selected);
+    }
+
+    public void setAction(DialogData.ActionData[] actions) {
+
+        model.clear();
+        if (actions == null)
+            return;
+        for (int i = 0; i < actions.length; i++) {
+            if (actions[i].grantRewards.length > 0) {
+                continue; //handled in separate editor and joined in on save, will get duplicated if it appears here
+            }
+            model.add(i, actions[i]);
+        }
+    }
+
+    public DialogData.ActionData[] getAction() {
+
+        DialogData.ActionData[] action = new DialogData.ActionData[model.getSize()];
+        for (int i = 0; i < model.getSize(); i++) {
+            action[i] = model.get(i);
+        }
+        return action;
+    }
+
+    public void clear() {
+        updating = true;
+        model.clear();
+        updating = false;
+    }
+
+    public void addChangeListener(ChangeListener listener) {
+        listenerList.add(ChangeListener.class, listener);
+    }
+}

adventure-editor/src/main/java/forge/adventure/editor/BiomeEdit.java

@@ -51,12 +51,12 @@ public class BiomeEdit extends FormPanel {
         add(terrain);
         add(structures);
 
-        name.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeEdit.this.updateTerrain()));
-        tilesetName.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeEdit.this.updateTerrain()));
-        color.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeEdit.this.updateTerrain()));
+        name.getDocument().addDocumentListener(new DocumentChangeListener(BiomeEdit.this::updateTerrain));
+        tilesetName.getDocument().addDocumentListener(new DocumentChangeListener(BiomeEdit.this::updateTerrain));
+        color.getDocument().addDocumentListener(new DocumentChangeListener(BiomeEdit.this::updateTerrain));
         collision.addChangeListener(e -> BiomeEdit.this.updateTerrain());
-        spriteNames.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeEdit.this.updateTerrain()));
-        enemies.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeEdit.this.updateTerrain()));
+        spriteNames.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(BiomeEdit.this::updateTerrain));
+        enemies.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(BiomeEdit.this::updateTerrain));
         terrain.addChangeListener(e -> BiomeEdit.this.updateTerrain());
 
 
@@ -64,7 +64,7 @@ public class BiomeEdit extends FormPanel {
         startPointY.addChangeListener(e -> BiomeEdit.this.updateTerrain());
         noiseWeight.addChangeListener(e -> BiomeEdit.this.updateTerrain());
         distWeight.addChangeListener(e -> BiomeEdit.this.updateTerrain());
-        tilesetAtlas.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeEdit.this.updateTerrain()));
+        tilesetAtlas.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(BiomeEdit.this::updateTerrain));
         width.addChangeListener(e -> BiomeEdit.this.updateTerrain());
         height.addChangeListener(e -> BiomeEdit.this.updateTerrain());
         refresh();

adventure-editor/src/main/java/forge/adventure/editor/BiomeStructureDataMappingEditor.java

@@ -45,17 +45,16 @@ public class BiomeStructureDataMappingEditor extends JComponent {
                 JList list, Object value, int index,
                 boolean isSelected, boolean cellHasFocus) {
             JLabel label = (JLabel) super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
-            if(!(value instanceof BiomeStructureData.BiomeStructureDataMapping))
+            if(!(value instanceof BiomeStructureData.BiomeStructureDataMapping biomeData))
                 return label;
-            BiomeStructureData.BiomeStructureDataMapping data=(BiomeStructureData.BiomeStructureDataMapping) value;
             // Get the renderer component from parent class
 
-            label.setText(data.name);
+            label.setText(biomeData.name);
             if(editor.data!=null)
             {
                 SwingAtlas itemAtlas=new SwingAtlas(Config.instance().getFile(editor.data.structureAtlasPath));
-                if(itemAtlas.has(data.name))
-                    label.setIcon(itemAtlas.get(data.name));
+                if(itemAtlas.has(biomeData.name))
+                    label.setIcon(itemAtlas.get(biomeData.name));
                 else
                 {
                     ImageIcon img=itemAtlas.getAny();
@@ -135,8 +134,8 @@ public class BiomeStructureDataMappingEditor extends JComponent {
             add("color:",color);
             add("collision:",collision);
 
-            name.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeStructureDataMappingEdit.this.update()));
-            color.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeStructureDataMappingEdit.this.update()));
+            name.getDocument().addDocumentListener(new DocumentChangeListener(BiomeStructureDataMappingEdit.this::update));
+            color.getDocument().addDocumentListener(new DocumentChangeListener(BiomeStructureDataMappingEdit.this::update));
             collision.addChangeListener(e -> BiomeStructureDataMappingEdit.this.update());
             refresh();
         }

adventure-editor/src/main/java/forge/adventure/editor/BiomeStructureEdit.java

@@ -45,7 +45,7 @@ public class BiomeStructureEdit extends FormPanel {
         add(center);
         add(data);
 
-        structureAtlasPath.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeStructureEdit.this.updateStructure()));
+        structureAtlasPath.getDocument().addDocumentListener(new DocumentChangeListener(BiomeStructureEdit.this::updateStructure));
 
 
         x.addChangeListener(e -> BiomeStructureEdit.this.updateStructure());
@@ -55,8 +55,8 @@ public class BiomeStructureEdit extends FormPanel {
         randomPosition.addChangeListener(e -> BiomeStructureEdit.this.updateStructure());
 
         N.addChangeListener(e -> BiomeStructureEdit.this.updateStructure());
-        sourcePath.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeStructureEdit.this.updateStructure()));
-        maskPath.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeStructureEdit.this.updateStructure()));
+        sourcePath.getDocument().addDocumentListener(new DocumentChangeListener(BiomeStructureEdit.this::updateStructure));
+        maskPath.getDocument().addDocumentListener(new DocumentChangeListener(BiomeStructureEdit.this::updateStructure));
         periodicInput.addChangeListener(e -> BiomeStructureEdit.this.updateStructure());
         ground.addChangeListener(e -> BiomeStructureEdit.this.updateStructure());
         symmetry.addChangeListener(e -> BiomeStructureEdit.this.updateStructure());

adventure-editor/src/main/java/forge/adventure/editor/BiomeTerrainEdit.java

@@ -27,7 +27,7 @@ public class BiomeTerrainEdit extends FormPanel {
         center.add("resolution:",resolution);
         add(center,preview);
 
-        spriteName.getDocument().addDocumentListener(new DocumentChangeListener(() -> BiomeTerrainEdit.this.updateTerrain()));
+        spriteName.getDocument().addDocumentListener(new DocumentChangeListener(BiomeTerrainEdit.this::updateTerrain));
 
         min.addChangeListener(e -> BiomeTerrainEdit.this.updateTerrain());
         max.addChangeListener(e -> BiomeTerrainEdit.this.updateTerrain());

adventure-editor/src/main/java/forge/adventure/editor/DialogOptionEdit.java

@@ -40,8 +40,8 @@ public class DialogOptionEdit extends FormPanel {
 
         add(middle);
 
-        name.getDocument().addDocumentListener(new DocumentChangeListener(() -> DialogOptionEdit.this.updateDialog()));
-        text.getDocument().addDocumentListener(new DocumentChangeListener(() -> DialogOptionEdit.this.updateDialog()));
+        name.getDocument().addDocumentListener(new DocumentChangeListener(DialogOptionEdit.this::updateDialog));
+        text.getDocument().addDocumentListener(new DocumentChangeListener(DialogOptionEdit.this::updateDialog));
 
 
     }

adventure-editor/src/main/java/forge/adventure/editor/DialogOptionEditor.java

@@ -25,9 +25,8 @@ public class DialogOptionEditor extends JComponent{
                 JList list, Object value, int index,
                 boolean isSelected, boolean cellHasFocus) {
             JLabel label = (JLabel) super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
-            if(!(value instanceof DialogData))
+            if(!(value instanceof DialogData dialog))
                 return label;
-            DialogData dialog=(DialogData) value;
             StringBuilder builder=new StringBuilder();
             if(dialog.name==null||dialog.name.isEmpty())
                 builder.append("[[Blank Option]]");

adventure-editor/src/main/java/forge/adventure/editor/DialogTree.java

@@ -49,12 +49,7 @@ public class DialogTree extends JPanel {
 
     public void addSelectionListener(){
         //subscribe to valueChanged, change to that object in edit pane
-        dialogTree.getSelectionModel().addTreeSelectionListener(new TreeSelectionListener() {
-            @Override
-            public void valueChanged(TreeSelectionEvent e) {
-                emitChanged(e);
-            }
-        });
+        dialogTree.getSelectionModel().addTreeSelectionListener(this::emitChanged);
 
     }
 

adventure-editor/src/main/java/forge/adventure/editor/EditorMainWindow.java

@@ -0,0 +1,97 @@
+package forge.adventure.editor;
+
+import forge.adventure.util.Config;
+
+import javax.swing.JButton;
+import javax.swing.JDialog;
+import javax.swing.JFrame;
+import javax.swing.JOptionPane;
+import javax.swing.JTabbedPane;
+import javax.swing.JToolBar;
+import javax.swing.UIManager;
+import java.awt.BorderLayout;
+import java.awt.Desktop;
+import java.awt.EventQueue;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
+import java.io.File;
+import java.security.CodeSource;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Editor class to edit configuration, maybe moved or removed
+ */
+public class EditorMainWindow extends JFrame {
+    public final static WorldEditor worldEditor = new WorldEditor();
+    JTabbedPane tabs = new JTabbedPane();
+
+    public EditorMainWindow(Config config) {
+        UIManager.LookAndFeelInfo[] var1 = UIManager.getInstalledLookAndFeels();
+
+        for (UIManager.LookAndFeelInfo info : var1) {
+            if ("Nimbus".equals(info.getName())) {
+                try {
+                    UIManager.setLookAndFeel(info.getClassName());
+                } catch (Throwable ignored) {
+                }
+                break;
+            }
+        }
+        this.setDefaultCloseOperation(JFrame.DO_NOTHING_ON_CLOSE);
+        this.addWindowListener(new WindowAdapter() {
+            @Override
+            public void windowClosing(WindowEvent e) {
+                setVisible(false);
+                System.exit(0);
+            }
+        });
+        BorderLayout layout = new BorderLayout();
+        JToolBar toolBar = new JToolBar("toolbar");
+        JButton newButton = new JButton("GDX Particle Editor Tool");
+        newButton.addActionListener(e -> EventQueue.invokeLater(() -> {
+            newButton.setEnabled(false);
+            try {
+                CodeSource codeSource = EditorMainWindow.class.getProtectionDomain().getCodeSource();
+                File jarFile = new File(codeSource.getLocation().toURI().getPath());
+                String jarDir = jarFile.getParentFile().getPath();
+                Desktop.getDesktop().open(new File(jarDir + "/gdx-particle-editor.jar"));
+            } catch (Exception ex) {
+                new ErrorDialog("Error", ex.getMessage());
+                newButton.setEnabled(true);
+            }
+        }));
+        JButton quit = new JButton("Quit");
+        quit.addActionListener(e -> System.exit(0));
+        toolBar.add(newButton);
+        toolBar.add(quit);
+        setLayout(layout);
+        toolBar.setFloatable(false);
+        add(toolBar, BorderLayout.NORTH);
+        add(tabs, BorderLayout.CENTER);
+        tabs.addTab("World", worldEditor);
+        tabs.addTab("POI", new PointOfInterestEditor());
+        tabs.addTab("Items", new ItemsEditor());
+        tabs.addTab("Enemies", new EnemyEditor());
+        tabs.addTab("Quests", new QuestEditor());
+        setSize(config.getSettingData().width, config.getSettingData().height);
+        setLocationRelativeTo(null);
+        setVisible(true);
+    }
+
+    static class ErrorDialog {
+        public ErrorDialog(String title, String message) {
+            List<Object> options = new ArrayList<>();
+            JButton ok = new JButton("OK");
+            options.add(ok);
+            JOptionPane pane = new JOptionPane(message, JOptionPane.PLAIN_MESSAGE, JOptionPane.DEFAULT_OPTION, null, options.toArray());
+            JDialog dlg = pane.createDialog(JOptionPane.getRootFrame(), title);
+            ok.addActionListener(e -> {
+                dlg.setVisible(false);
+                System.exit(0);
+            });
+            dlg.setResizable(false);
+            dlg.setVisible(true);
+        }
+    }
+}

adventure-editor/src/main/java/forge/adventure/editor/EffectEditor.java

@@ -42,8 +42,8 @@ public class EffectEditor extends JComponent  {
         lifeModifier.addChangeListener(e -> EffectEditor.this.updateEffect());
         moveSpeed.addChangeListener(e -> EffectEditor.this.updateEffect());
         colorView.addChangeListener(e -> EffectEditor.this.updateEffect());
-        name.getDocument().addDocumentListener(new DocumentChangeListener(() -> EffectEditor.this.updateEffect()));
-        startBattleWithCard.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> EffectEditor.this.updateEffect()));
+        name.getDocument().addDocumentListener(new DocumentChangeListener(EffectEditor.this::updateEffect));
+        startBattleWithCard.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(EffectEditor.this::updateEffect));
         if(opponent!=null)
 
             opponent.addChangeListener(e -> EffectEditor.this.updateEffect());
@@ -57,9 +57,9 @@ public class EffectEditor extends JComponent  {
  
 
         currentData.name=name.getText();
-        currentData.changeStartCards=((Integer)changeStartCards.getValue()).intValue();
-        currentData.lifeModifier= ((Integer)lifeModifier.getValue()).intValue();
-        currentData.moveSpeed= ((Float)moveSpeed.getValue()).floatValue();
+        currentData.changeStartCards = (Integer) changeStartCards.getValue();
+        currentData.lifeModifier = (Integer) lifeModifier.getValue();
+        currentData.moveSpeed = (Float) moveSpeed.getValue();
         currentData.startBattleWithCard = startBattleWithCard.getList();
         currentData.colorView = colorView.isSelected();
         currentData.opponent = opponent.currentData;

adventure-editor/src/main/java/forge/adventure/editor/EnemyEdit.java

@@ -289,7 +289,7 @@ public class EnemyEdit extends FormPanel {
             tags.add(e.nextElement());
         }
 
-        tags.removeIf(q -> q.isEmpty());
+        tags.removeIf(String::isEmpty);
         currentData.questTags = tags.toArray(currentData.questTags);
         QuestController.getInstance().refresh();
         filterExisting(enemyModel);

adventure-editor/src/main/java/forge/adventure/editor/FilePicker.java

@@ -4,8 +4,6 @@ import forge.adventure.util.Config;
 
 import javax.swing.*;
 import javax.swing.filechooser.FileNameExtensionFilter;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
 import java.io.File;
 import java.io.IOException;
 
@@ -21,12 +19,7 @@ public class FilePicker extends Box {
         super(BoxLayout.X_AXIS);
         this.fileEndings = fileEndings;
 
-        findButton.addActionListener(new ActionListener() {
-            @Override
-            public void actionPerformed(ActionEvent e) {
-                FilePicker.this.find();
-            }
-        });
+        findButton.addActionListener(e -> FilePicker.this.find());
 
         add(edit);
         add(findButton);

adventure-editor/src/main/java/forge/adventure/editor/FloatSpinner.java

@@ -14,6 +14,6 @@ public class FloatSpinner extends JSpinner{
     }
     public float floatValue()
     {
-        return ((Float)getValue()).floatValue();
+        return (Float) getValue();
     }
 }

adventure-editor/src/main/java/forge/adventure/editor/IntSpinner.java

@@ -15,6 +15,6 @@ public class IntSpinner extends JSpinner {
     }
     public int intValue()
     {
-        return ((Integer)getValue()).intValue();
+        return (Integer) getValue();
     }
 }

adventure-editor/src/main/java/forge/adventure/editor/ItemEdit.java

@@ -38,10 +38,10 @@ public class ItemEdit extends JComponent {
         add(effect);
         add(new Box.Filler(new Dimension(0,0),new Dimension(0,Integer.MAX_VALUE),new Dimension(0,Integer.MAX_VALUE)));
 
-        nameField.getDocument().addDocumentListener(new DocumentChangeListener(() -> ItemEdit.this.updateItem()));
-        equipmentSlot.getDocument().addDocumentListener(new DocumentChangeListener(() -> ItemEdit.this.updateItem()));
-        description.getDocument().addDocumentListener(new DocumentChangeListener(() -> ItemEdit.this.updateItem()));
-        iconName.getDocument().addDocumentListener(new DocumentChangeListener(() -> ItemEdit.this.updateItem()));
+        nameField.getDocument().addDocumentListener(new DocumentChangeListener(ItemEdit.this::updateItem));
+        equipmentSlot.getDocument().addDocumentListener(new DocumentChangeListener(ItemEdit.this::updateItem));
+        description.getDocument().addDocumentListener(new DocumentChangeListener(ItemEdit.this::updateItem));
+        iconName.getDocument().addDocumentListener(new DocumentChangeListener(ItemEdit.this::updateItem));
         cost.addChangeListener(e -> ItemEdit.this.updateItem());
         questItem.addChangeListener(e -> ItemEdit.this.updateItem());
         effect.addChangeListener(e -> ItemEdit.this.updateItem());
@@ -57,7 +57,7 @@ public class ItemEdit extends JComponent {
         currentData.description=description.getText();
         currentData.iconName=iconName.getText();
         currentData.questItem=questItem.isSelected();
-        currentData.cost=((Integer)  cost.getValue()).intValue();
+        currentData.cost= (Integer) cost.getValue();
     }
 
     public void setCurrentItem(ItemData data)

adventure-editor/src/main/java/forge/adventure/editor/ItemsEditor.java

@@ -27,17 +27,16 @@ public class ItemsEditor extends JComponent {
                 JList list, Object value, int index,
                 boolean isSelected, boolean cellHasFocus) {
             JLabel label = (JLabel) super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
-            if(!(value instanceof ItemData))
+            if(!(value instanceof ItemData item))
                 return label;
-            ItemData Item=(ItemData) value;
             // Get the renderer component from parent class
 
-            label.setText(Item.name);
+            label.setText(item.name);
             if(itemAtlas==null)
                 itemAtlas=new SwingAtlas(Config.instance().getFile(Paths.ITEMS_ATLAS));
             
-            if(itemAtlas.has(Item.iconName))
-                label.setIcon(itemAtlas.get(Item.iconName));
+            if(itemAtlas.has(item.iconName))
+                label.setIcon(itemAtlas.get(item.iconName));
             else
             {
                 ImageIcon img=itemAtlas.getAny();

adventure-editor/src/main/java/forge/adventure/editor/QuestEdit.java

@@ -2,10 +2,23 @@ package forge.adventure.editor;
 
 import forge.adventure.data.AdventureQuestData;
 
-import javax.swing.*;
+import javax.swing.AbstractAction;
+import javax.swing.BoxLayout;
+import javax.swing.DefaultListModel;
+import javax.swing.JButton;
+import javax.swing.JCheckBox;
+import javax.swing.JLabel;
+import javax.swing.JList;
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.JTabbedPane;
+import javax.swing.JTextArea;
+import javax.swing.JTextField;
+import javax.swing.KeyStroke;
 import javax.swing.event.ListDataEvent;
 import javax.swing.event.ListDataListener;
-import java.awt.*;
+import java.awt.BorderLayout;
+import java.awt.Dimension;
 import java.awt.event.ActionEvent;
 import java.util.ArrayList;
 import java.util.Enumeration;
@@ -285,7 +298,7 @@ public class QuestEdit extends FormPanel {
         }
         setVisible(true);
         updating=true;
-        id.setText(currentData.getID() + "");
+        id.setText(String.valueOf(currentData.getID()));
         name.setText(currentData.name);
         description.setText(currentData.description);
         synopsis.setText(currentData.synopsis);

adventure-editor/src/main/java/forge/adventure/editor/QuestEditor.java

@@ -26,9 +26,8 @@ public class QuestEditor extends JComponent {
                 JList list, Object value, int index,
                 boolean isSelected, boolean cellHasFocus) {
             JLabel label = (JLabel) super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
-            if(!(value instanceof AdventureQuestData))
+            if(!(value instanceof AdventureQuestData quest))
                 return label;
-            AdventureQuestData quest=(AdventureQuestData) value;
             // Get the renderer component from parent class
 
             label.setText(quest.name);

adventure-editor/src/main/java/forge/adventure/editor/QuestStageEditor.java

@@ -26,9 +26,8 @@ public class QuestStageEditor extends JComponent{
                 JList list, Object value, int index,
                 boolean isSelected, boolean cellHasFocus) {
             JLabel label = (JLabel) super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
-            if(!(value instanceof AdventureQuestStage))
+            if(!(value instanceof AdventureQuestStage stageData))
                 return label;
-            AdventureQuestStage stageData=(AdventureQuestStage) value;
             label.setText(stageData.name);
             //label.setIcon(new ImageIcon(Config.instance().getFilePath(stageData.sourcePath))); //Type icon eventually?
             return label;

adventure-editor/src/main/java/forge/adventure/editor/RewardEdit.java

@@ -25,10 +25,10 @@ public class RewardEdit extends FormPanel {
     TextListEdit colors =new TextListEdit(new String[] { "White", "Blue", "Black", "Red", "Green" });
     TextListEdit rarity =new TextListEdit(new String[] { "Basic Land", "Common", "Uncommon", "Rare", "Mythic Rare" });
     TextListEdit subTypes =new TextListEdit();
-    TextListEdit cardTypes =new TextListEdit(Arrays.asList(CardType.CoreType.values()).stream().map(CardType.CoreType::toString).toArray(String[]::new));
-    TextListEdit superTypes =new TextListEdit(Arrays.asList(CardType.Supertype.values()).stream().map(CardType.Supertype::toString).toArray(String[]::new));
+    TextListEdit cardTypes =new TextListEdit(Arrays.stream(CardType.CoreType.values()).map(CardType.CoreType::toString).toArray(String[]::new));
+    TextListEdit superTypes =new TextListEdit(Arrays.stream(CardType.Supertype.values()).map(CardType.Supertype::toString).toArray(String[]::new));
     TextListEdit manaCosts =new TextListEdit();
-    TextListEdit keyWords =new TextListEdit(Arrays.asList(Keyword.values()).stream().map(Keyword::toString).toArray(String[]::new));
+    TextListEdit keyWords =new TextListEdit(Arrays.stream(Keyword.values()).map(Keyword::toString).toArray(String[]::new));
     JComboBox colorType =new JComboBox(new String[] { "Any", "Colorless", "MultiColor", "MonoColor"});
     JTextField cardText =new JTextField();
     private boolean updating=false;
@@ -58,18 +58,18 @@ public class RewardEdit extends FormPanel {
         probability.addChangeListener(e -> RewardEdit.this.updateReward());
         count.addChangeListener(e -> RewardEdit.this.updateReward());
         addMaxCount.addChangeListener(e -> RewardEdit.this.updateReward());
-        cardName.getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        itemName.getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        editions.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        colors.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        rarity.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        subTypes.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        cardTypes.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        superTypes.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        manaCosts.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
-        keyWords.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
+        cardName.getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        itemName.getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        editions.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        colors.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        rarity.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        subTypes.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        cardTypes.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        superTypes.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        manaCosts.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
+        keyWords.getEdit().getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
         colorType.addActionListener((e -> RewardEdit.this.updateReward()));
-        cardText.getDocument().addDocumentListener(new DocumentChangeListener(() -> RewardEdit.this.updateReward()));
+        cardText.getDocument().addDocumentListener(new DocumentChangeListener(RewardEdit.this::updateReward));
 
     }
 
@@ -122,7 +122,7 @@ public class RewardEdit extends FormPanel {
         updating=true;
         typeField.setSelectedItem(currentData.type);
 
-        probability.setValue(new Double(currentData.probability));
+        probability.setValue((double) currentData.probability);
         count.setValue(currentData.count);
         addMaxCount.setValue(currentData.addMaxCount);
         cardName.setText(currentData.cardName);

adventure-editor/src/main/java/forge/adventure/editor/StructureEditor.java

@@ -68,12 +68,7 @@ public class StructureEditor extends JComponent{
         add(edit,BorderLayout.CENTER);
 
 
-        edit.addChangeListener(new ChangeListener() {
-            @Override
-            public void stateChanged(ChangeEvent e) {
-                emitChanged();
-            }
-        });
+        edit.addChangeListener(e -> emitChanged());
     }
     protected void emitChanged() {
         ChangeListener[] listeners = listenerList.getListeners(ChangeListener.class);

adventure-editor/src/main/java/forge/adventure/editor/SwingAtlas.java

@@ -5,7 +5,7 @@ import com.badlogic.gdx.graphics.g2d.TextureAtlas;
 import com.badlogic.gdx.utils.Array;
 
 import javax.imageio.ImageIO;
-import javax.swing.*;
+import javax.swing.ImageIcon;
 import java.awt.image.BufferedImage;
 import java.io.IOException;
 import java.util.ArrayList;
@@ -65,7 +65,7 @@ public class SwingAtlas {
             return new ImageIcon(img.getSubimage(sprite.left,sprite.top, sprite.width, sprite.height).getScaledInstance((int) (imageSize*(sprite.width/(float)sprite.height)),imageSize,SCALE_FAST));
 
         }
-        catch (IOException e)
+        catch (Exception e)
         {
             return null;
         }

adventure-editor/src/main/java/forge/adventure/editor/TerrainsEditor.java

@@ -3,10 +3,17 @@ package forge.adventure.editor;
 import forge.adventure.data.BiomeData;
 import forge.adventure.data.BiomeTerrainData;
 
-import javax.swing.*;
+import javax.swing.DefaultListCellRenderer;
+import javax.swing.DefaultListModel;
+import javax.swing.JButton;
+import javax.swing.JComponent;
+import javax.swing.JLabel;
+import javax.swing.JList;
+import javax.swing.JToolBar;
 import javax.swing.event.ChangeEvent;
 import javax.swing.event.ChangeListener;
-import java.awt.*;
+import java.awt.BorderLayout;
+import java.awt.Component;
 import java.awt.event.ActionListener;
 
 /**
@@ -29,11 +36,11 @@ public class TerrainsEditor extends JComponent{
             if(!(value instanceof BiomeTerrainData))
                 return label;
             BiomeTerrainData terrainData=(BiomeTerrainData) value;
-            StringBuilder builder=new StringBuilder();
+            /*StringBuilder builder=new StringBuilder();
             builder.append("Terrain");
             builder.append(" ");
-            builder.append(terrainData.spriteName);
-            label.setText(builder.toString());
+            builder.append(terrainData.spriteName);*/
+            label.setText("Terrain " + terrainData.spriteName);
             return label;
         }
     }
@@ -60,12 +67,7 @@ public class TerrainsEditor extends JComponent{
         add(edit,BorderLayout.CENTER);
 
 
-        edit.addChangeListener(new ChangeListener() {
-            @Override
-            public void stateChanged(ChangeEvent e) {
-                emitChanged();
-            }
-        });
+        edit.addChangeListener(e -> emitChanged());
     }
     protected void emitChanged() {
         ChangeListener[] listeners = listenerList.getListeners(ChangeListener.class);

adventure-editor/src/main/java/forge/adventure/editor/WorldEditor.java

@@ -9,8 +9,6 @@ import forge.adventure.util.Config;
 import forge.adventure.util.Paths;
 
 import javax.swing.*;
-import javax.swing.event.ListSelectionEvent;
-import javax.swing.event.ListSelectionListener;
 import java.awt.*;
 import java.io.File;
 import java.io.IOException;
@@ -45,9 +43,8 @@ public class WorldEditor extends JComponent {
                 JList list, Object value, int index,
                 boolean isSelected, boolean cellHasFocus) {
             JLabel label = (JLabel) super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
-            if(!(value instanceof BiomeData))
+            if(!(value instanceof BiomeData biome))
                 return label;
-            BiomeData biome=(BiomeData) value;
             // Get the renderer component from parent class
 
             label.setText(biome.name);
@@ -81,12 +78,7 @@ public class WorldEditor extends JComponent {
 
     public WorldEditor() {
         list.setCellRenderer(new BiomeDataRenderer());
-        list.addListSelectionListener(new ListSelectionListener() {
-            @Override
-            public void valueChanged(ListSelectionEvent e) {
-                WorldEditor.this.updateBiome();
-            }
-        });
+        list.addListSelectionListener(e -> WorldEditor.this.updateBiome());
         BorderLayout layout = new BorderLayout();
         setLayout(layout);
         add(tabs);

docs/AI.md

@@ -0,0 +1,68 @@
+# About Forge's Artificial Intelligence
+
+The AI is *not* "trained". It uses basic rules and can be easy to overcome knowing it's weaknesses.
+
+The AI is:
+* Best with Aggro and midrange decks
+* Poor to Ok in control decks
+* Pretty bad for most combo decks
+
+If you want to train a model for the AI, please do. We would love to see something like that implemented in Forge.
+
+# AI Matches from Command Line
+
+The AI can battle itself in the command line, allowing the tests to be performed on headless servers or on computers that have poor graphic performance, and when you just don't need to see the match. This can be useful if you want to script testing of decks, test a large tournament, or just bash 100's of games out to see how well a deck performs.
+
+Please understand, the AI is still the AI, and it's limitations exist even against itself. Games can lag and become almost unbearably long when the AI has a lot to think about, and you can't see what's on the table for it to play against. It's best if you set up the tournament and walk away, you can analyze logs later, results are printed at the end.
+
+## Syntax 
+
+`sim -d <deck1[.dck]> ... <deckX[.dck]> -D [path] -n [N] -f [F] -t [T] -p [P] -q`
+
+In linux and mac, command line arguments are not currently passed through the sh script, please call `java -jar` manually, instead of the exe.
+- `sim` - "Simulation Mode" forces Forge to not start the GUI and automatically runs the AI matches in command line. Enables all other switches for simulation mode.
+- `-d <deck1[.dck]> ... <deckX[.dck]>` - Space separated list of deck files, in `-f` game type path. (For example; If `-f` is set to Commander, decks from `<userdata>/decks/commander/` will be searched. If `-f` is not set then default is `<userdata>/decks/constructed/`.) Names must use quote marks when they contain spaces.
+  - `deck1.dck` - Literal deck file name, when the value has ".dck" extension.
+  - `deck` - A meta deck name of a deck file.
+- `-D [path]` - [path] is absolute directory path to load decks from. (Overrides path for `-d`.)
+- `-n [N]` - [N] number of games, just flat test the AI multiple times. Default is 1.
+- `-m [M]` - [M] number of matches, best of [M] matches. (Overrides -n) Recommended 1, 3, or 5. Default is 1.
+- `-f [F]` - Runs [F] format of game. Default is "constructed" (other options may not work, list extracted from code)
+  - `Commander`
+  - `Oathbreaker`
+  - `TinyLeaders`
+  - `Brawl`
+  - `MomirBasic`
+  - `Vanguard`
+  - `MoJhoSto`
+- `-t [T]` - for Tournament Mode, [T] for type of tournament.
+  - `Bracket` - See wikipedia for [Bracket Tournament](https://en.wikipedia.org/wiki/Bracket_(tournament))
+  - `RoundRobin` - See wikipedia for [Round Robin Tournaments](https://en.wikipedia.org/wiki/Round-robin_tournament)
+  - `Swiss` - See wikipedia for [Swiss Pairing Tournaments](https://en.wikipedia.org/wiki/Swiss-system_tournament)
+- `-p [P]` - [P] number of players paired, only used in tournament mode. Default is 2.
+- `-q` - Quiet Mode, only prints the result not the entire log.
+
+## Examples
+In linux and macos you must run forge by evoking java and calling the jar, currently command line parameters are not passed through the script. The forge jar filename is truncated in these examples from `forge-whatever-version-youre-on.jar` to `forge.jar`.
+
+In Windows, if you use the EXE file as described below, the simulation runs in the background and output is sent to the forge log file only. If you want to have output to the console, please use the `java -jar` evocation of forge.
+
+To simulate a basic three games of two decks (deck1 and deck2 must be meta deck names of decks in `<userdata>\decks\constructed\`):
+- Windows/Linux/MacOS: `java -jar forge.jar sim -d deck1 deck2 -n 3`
+- Windows: `.\forge.exe sim -d deck1 deck2 -n 3`
+
+To simulate a single 3-player Commander game (deck1, deck2, and deck3 must be meta deck names of decks in `<userdata>\decks\commander\`):
+- Windows/Linux/MacOS: `java -jar forge.jar sim -d deck1 deck2 deck3 -f commander`
+- Windows: `.\forge.exe sim -d deck1 deck2 deck3 -f commander`
+
+To simulate a round robin tournament; best of three, with all decks in a directory:
+- Windows/Linux/MacOS: `java -jar forge.jar sim -D /path/to/DecksFolder/ -m 3 -t RoundRobin`
+- Windows: `.\forge.exe sim -D C:\DecksFolder\ -m 3 -t RoundRobin`
+
+To simulate a swiss tournament; best of three, all decks in a directory, 3 player pairings:
+- Windows/Linux/MacOS: `java -jar forge.jar sim -D /path/to/DecksFolder/ -m 3 -t Swiss -p 3`
+- Windows: `.\forge.exe sim -D C:\DecksFolder\ -m 3 -t Swiss -p 3`
+
+***
+
+Each game ends with an announcement of the winner, and the current status of the match. 

docs/Adventure-Mode.md

@@ -0,0 +1,12 @@
+# What is Adventure Mode?
+
+Adventure mode is a work-in-progress game mode where you explore the ever-changing landscape of Shandalar, duel creatures to earn gold and new cards to  battle the various bosses. You can visit towns to buy equipment and cards, and crawl through dungeons to find artifacts and loot to help you on your journey. Adventure mode is an awesome reimagining of the original "Shandalar" 1997 PC Game in Forge, even though the scope of adventure is much broader and we don't constrain ourselves to the lore of the plane of Shandalar. You can play Shandalar on Desktop (Linux, Windows, IOS) or on Android devices. 
+
+# 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 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/Card-Images.md

@@ -0,0 +1,109 @@
+# About
+
+Card images are assets used to represent the real cards in game. You DO NOT need images to play forge, however representing real cards is a nice ability forge provides. These images can be any image set you like, or custom images too.
+
+Primarily there are two types of images you'll care about; cards, and tokens.
+
+**Cards** - are the primary card image files, and can be generic (as all cards of the same name have the same rules) or per set since there may be different art work in different editions. Typically these are scans of the original cards and are provided by forge's FTP, or scryfall. You can customize a full generic set, or any edition if you desire... (you could for example, blur every card image and play a literal "blind" or "farsighted" game.)
+
+**Tokens** - are the images for the cards replacing a generic "1/1 zombie" for example. These are less frequently updated, and are typically the bulk of what is missing when doing an audit. However, these are probably where the more true "custom" replacements are available, with either custom artwork, or modified of other existing.
+
+# Downloading
+
+Due to charges in Forges hosting and scryfall terms you can no longer predownload card images. Turn on auto download in forge to download card images when first viewed.
+
+## In Forge Auto Download:
+
+**Download Missing Images - Setting**
+- This will download the images from the sources as the game requests the image in situ. 
+- This can be useful if you don't want to have copies of every card... You can do small pre-caching by loading your decks in the deck editor prior to playing to download just those images.
+
+## Bulk Download Sites: (Not in game)
+
+- [http://download.austeregrim.net](http://download.austeregrim.net) 
+  - Note from user AustereGrim;
+> I provide my site for free for bulk downloading the entire image catalog. So you don't need to give those spam sites more advertising spots. If the server is loaded bandwidth is shared, right now it's not heavily used so please feel free to download the 4+gb zips, or the individual zips if you need sets. They are the images Kev has uploaded to my site, and the Zips are updated nightly automatically.
+
+**(I'm not gatekeeping, please if you have a private location for bulk downloads or for alternate or custom arts, you can update this wiki too or let us know in the discord. I'll be happy to update the wiki page with additional sources.)**
+
+# Storage
+
+Card images are stored in `pics/cards`, and tokens in `pics/tokens`, in the Cache folder for forge: 
+
+- **Windows** - `C:\Users\<username>\appdata\local\forge\Cache\`
+  - You'll need to enable hidden folders.
+- **Android 11+** - `Internal Storage/Android/obb/forge.app/Forge/cache/`   
+  - *_NOTE: You need a third party File Manager to access the obb folder and allow storage access permission_*
+- **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.
+
+
+# Subfolders
+
+If you don't care about the edition's version of cards, images can be stored in the root directory of the cards folder.
+
+`/cache/pics/cards/`
+
+If you want the edition's versions of the cards, they need to go under the edition's code subfolder.
+
+`/cache/pics/cards/AFR` for example for Adventures in the Forgotten Realms.
+
+# File Naming
+
+**File Names:**
+- Cards file names follow a simple principle: `Card Name#.border.ext`
+  - `Card Name` - Card Name with spaces.
+  - `#` - Alternate Art number; if more than one art exists for the card.
+  - `border` - Border Type; fullborder, crop. (I don't know all of them.)
+  - `ext` - Extension, jpg or png are supported.
+
+**Alternate images:**
+
+Alternate images are defined as cards with the same name in the set's edition file, if the edition file does not have the alternate listed forge will not see the alternate there!
+
+**Standard Alternate Arts:**
+
+So for example the AFR set (as most sets) shows these 4 versions of swamp;
+```
+270 L Swamp @Piotr Dura
+271 L Swamp @Sarah Finnigan
+272 L Swamp @Titus Lunter
+273 L Swamp @Adam Paquette
+```
+The file naming would be represented by a number after the name:
+```
+Swamp1.fullborder.jpg
+Swamp2.fullborder.jpg
+Swamp3.fullborder.jpg
+Swamp4.fullborder.jpg
+```
+
+**Additional Alternate Arts:**
+
+They may also be listed separately as "extended arts", "showcase", or "borderless" in the same editions file:
+```
+[cards]
+90 U Black Dragon @Mark Zug
+```
+and 
+```
+[borderless]
+291 U Black Dragon @Jason A. Engle
+```
+Where the files are:
+```
+black dragon1.fullborder.jpg
+black dragon2.fullborder.jpg
+```
+
+**Forcing an Alternate:**
+
+Renaming and creating a second of an existing card **will not work**, for example creating two "Burning hands" which does not have alternate art;
+```
+burning hands1.fullborder.jpg
+burning hands2.fullborder.jpg
+```
+Forge will not see either of those, and will probably download the missing `burning hands.fullborder.jpg` for you. Similarly adding a 3rd black dragon `black dragon3.fullborder.jpg` will **not** work either.
+

docs/Card-scripting-API/AbilityFactory.md

@@ -0,0 +1,900 @@
+AbilityFactory parses differently from the Keyword parser. Your Ability line will look more like this:
+
+`A:{AB/SP/DB/ST}$ <AFSubclass> | {Necessary$ Parameters} | {Separated$ By} | {Pipes$ Here} | [Optional$ Values]`
+
+In most cases, each AF subclass implements both the Spell and Ability.
+Much of the code is shared, so creating the data object will look very similar.
+
+  - **AB** is for Activated Abilities
+  - **SP** is for Spell
+  - **DB** is for Drawback and many abilities that are subsidiary to other things, like replacements. They are only used to chain AFs together, and will never be the root AF
+  - **ST** is for Static, this gets used in case the API should resolve without using the stack<br> (e.g. the unique *Circling Vultures* special action is directly implemented in the script this way)
+
+>*NOTE:*
+> - these factories are refactored from time to time (often to adapt to new sets), so while some entries could be slightly outdated, the base information should still be correct
+> - a few factories also have _*All_ variants, these are slowly being phased out
+> - some parameters are only added for very exotic cards, these won't be included here to keep the focus on understanding the general concepts of scripting
+> - when in doubt you can always cross check with the [available APIs](https://github.com/Card-Forge/forge/tree/master/forge-game/src/main/java/forge/game/ability/effects) code
+
+# Common Parameters
+
+## Cost / UnlessCost
+
+`Cost$ <AbilityCost>` is the appropriate way to set the cost of the ability. Currently for spells, any additional costs including the original Mana cost need to appear in the Cost parameter in the AbilityFactory. For each card that uses it, the order in which the cost is paid will always be the same.
+
+Secondary abilities such as the DB executed by triggers or replacements (usually) don't need costs. (This is one reason to use DB over AB in these cases.)
+
+Read more about it in [Costs](Costs)
+
+## ValidTgts / Defined
+
+Most effects need to know (at least implicitly) which players or objects they're trying to affect. There are two different ways for that:
+- `ValidTgts` will need to be used for abilities that target
+- if your ability instead describes on what it's applied use `Defined`
+
+Read more about it in [Affected / Targets](Targeting)
+
+## Restrictions / Conditions
+
+Restrictions limit when abilities can be put on the stack and Conditions apply during resolving. Common examples are Putrid Leech's only activate this once per turn or different cards that can activate from Zones like the Hand or the Graveyard.
+
+Read more about it in [Restriction](Restrictions)
+
+## SpellDescription
+
+SpellDescription is how the text of the ability will display on the card and in the option dialog for cards with multiple abilities.
+
+The SpellDescription for secondary abilities (both AB and DB) is now displayed when (and if) the ability prompts for user input in the prompt pane so it is useful to put some nice text there.
+
+## StackDescription
+
+*(Optional)* StackDescription is the description the ability will have on the stack. This is automatically generated by the effect, but may be overridden using this parameter. This is sometimes needed with complex effects, when the generated text can't handle some details. Properties of the spell can be accessed like this: {c:Targeted}. You can reuse the spell text by just putting `SpellDescription` or `None` to leave it empty.
+
+## Remember*
+
+Remembering is often needed when a card becomes a new object, which is then further affected by the ability. Typical example: [Flicker](https://github.com/Card-Forge/forge/blob/master/forge-gui/res/cardsfolder/f/flicker.txt)<br>
+Because cards keep their remembered parts when changing zones manual [cleanup](#Cleanup) is usually required.
+
+## AI params
+
+`IsCurse$ True` - For effects that are normally treated positive e.g. Pump
+
+`AITgts$ BetterThanEvalRating.130`
+
+# Factories (in Alphabetical Order)
+
+## AlterLife
+
+AlterLife is for Abilities that Alter a player's life total.
+
+### GainLife
+
+Have a player gain the specified amount of life.
+
+`A:AB$ GainLife | Cost$ T | LifeAmount$ 1 | SpellDescription$ You gain 1 life.`  
+
+LifeAmount$ is required. This is how much life you will gain.
+
+Defined is optional, if it appears the defined player(s) gain life.
+Target is optional, if it appears and Defined doesn't then targeted player(s) gain life.
+
+### LoseLife
+
+Have a player lose the specified amount of life.
+
+`A:AB$ LoseLife | Cost$ Sac<1/CARDNAME> | ValidTgts$ Player | TgtPrompt$ Target a player to lose a life | LifeAmount$ 1 | SpellDescription$ Target player loses 1 life.`   
+`A:SP$ LoseLife | Cost$ 2 B | Defined$ Opponent | LifeAmount$ 2 | SpellDescription$ Each opponent loses 2 life.`
+
+LifeAmount$ is required. This is how much life will be lost.
+
+Target is optional. If Target doesn't appear then Defined will be used.
+Remember, if Defined is missing, the default for Players is "You"
+
+Part of resolving sets the **SVar AFLifeLost** to the amount of life lost by all players.
+
+### SetLife
+
+SetLife sets one or both player's life total to a specified value (i.e.
+"your life total becomes 20" or "Target player's life total is equal to
+the number of cards in your graveyard").
+
+`A:SP$ SetLife | Cost$ 7 W W | ValidTgts$ Player | TgtPrompt$ Select target player | LifeAmount$ 20 | SpellDescription$ Target player's life total becomes 20.`
+
+Parameters:  
+LifeAmount (required) - the value to set the life total(s) to
+
+Defined is optional. If it exists, it will be used. Target is optional.
+If it exists and defined doesn't it will be used. Default player is "You".
+
+### ExchangeLife
+
+ExchangeLife switches the Life total of two players.
+
+`A:AB$ ExchangeLife | Cost$ 6 T | ValidTgts$ Player | TargetMin$ 2 | TargetMax$ 2 | TgtPrompt$ Select target player | SpellDescription$ Two target players exchange life totals.`
+
+One of Defined or Target is required, since there needs to be two
+Players exchanging life If Defined it will be used. If Target exists and
+defined doesn't it will be used.
+
+If there aren't two determined players by the SA, the activating player is added as the second player.
+
+## Animate
+
+Animate handles animation effects like "This card becomes a 5/5
+green creature with flying until end of turn." It is designed to handle
+color changing, type changing, P/T setting, and granting/removing abilities.
+
+`A:SP$Animate | Cost$ G | ValidTgts$ Land | TgtPrompt$ Select target land | Power$ 3 | Toughness$ 3 | Types$ Creature | SpellDescription$ Until end of turn, target land becomes a 3/3 creature that's still a land.`
+
+`A:AB$Animate | Cost$ 1 B | Defined$ Self | Power$ 1 | Toughness$ 1 | Types$ Creature,Skeleton | Colors$ Black | Abilities$ ABRegen | SpellDescription$ CARDNAME becomes a 1/1 black Skeleton creature with "B: Regenerate this creature" until end of turn. It's still a land. (If it regenerates, the next time it would be destroyed this turn, it isn't. Instead tap it, remove all damage from it, and remove it from combat.)`  
+`SVar:ABRegen:AB$Regenerate | Cost$ B | SpellDescription$ Regenerate CARDNAME.`
+
+`A:AB$Animate | Cost$ 2 R G | Defined$ Self | Power$ 3 | Toughness$ 3 | Types$ Creature,Elemental | Colors$ Red,Green | Triggers$ TrigAttack | SpellDescription$ Until end of turn, CARDNAME becomes a 3/3 red and green Elemental creature with "Whenever this creature attacks, put a +1/+1 counter on it." It's still a land.`  
+`SVar:TrigAttack:Mode$ Attacks | ValidCard$ Creature.Self | Execute$ TrigPutCounter | TriggerDescription$ Whenever CARDNAME attacks, put a +1/+1 counter on it.`  
+`SVar:TrigPutCounter:AB$PutCounter | Cost$ 0 | Defined$ Self | CounterType$ P1P1 | CounterNum$ 1`
+
+Parameters:
+
+ - Power (required) - the power to assign to the animated card
+ - Toughness (required) - the toughness to assign to the animated card
+ - Types (optional) - the additional types to give the animated card;
+    comma delimited
+ - OverwriteTypes (optional) - set to True if the animated being should
+    have these types **instead** as opposed to **in addition to**
+ - RemoveTypes (optional) - a list of types to Remove from the animated
+    card
+ - ChosenType (optional) - overrides types before it and just will add
+    the ChosenType
+ - Keywords (optional) - a " & " delimited list of keywords to give the
+    animated being (just like AB$Pump)
+ - HiddenKeywords (optional) - a " & " delimited list of hidden
+    keywords to give the animated being (just like AB$Pump)
+ - RemoveKeywords (optional) - a " & " delimited list of keywords to
+    remove from the animated being (just like AB$Debuff)
+ - Colors (optional) - a comma-delimited list of Colors to give to the
+    animated being (capitalized and spelled out) (ChosenColor accepted)
+ - Abilities (optional) - a comma-delimited list of SVar names which
+    contain abilities that should be granted to the animated being
+ - OverwriteAbilities - Remove Abilities from animated being
+ - Triggers (optional) - a comma-delimited list of SVar names which
+    contain triggers that should be granted to the animated being
+ - OverwriteTriggers - Remove/suppress triggers from animated being
+ - staticAbilities (optional) - a comma-delimited list of SVar names
+    which contain static abilities that should be granted to the
+    animated being
+ - OverwriteStatics- Remove static abilities from animated being
+ - OverwriteReplacements - Remove replacement effects from animated
+    being
+ - RemoveAllAbilities - Remove all Abilities, Triggers, Statics, and
+    Replacement effects
+ - sVars(optional) - a comma-delimited list of SVars that should be
+    granted to the animated being
+ - Duration (Default is end of turn)
+    - Permanent
+   - UntilEndOfCombat - if the effect should last only until End of Combat instead of End of Turn
+   - UntilHostLeavesPlay - if the effect should last as long as the host is still in play
+   - UntilYourNextUpkeep
+   - UntilControllerNextUntap
+   - UntilYourNextTurn
+
+Target is optional, will be used if possible. Defined is optional, will be used if no Targets (Self by default)
+
+## Attach
+
+Attach is being used directly only for Auras, primarily for Aura Spells, but also for Auras entering the battlefield by some effect.
+
+`AB$ Attach | Cost$ R R | ValidTgts$ Creature | AILogic$ Pump`
+
+Parameters:
+
+  - Object (optional) - This is the Object that will be Attached
+    (generally the Source Card for Auras)
+  - AILogic - AI Logic tells the AI which base AI code it should use for
+    Attaching
+      - GainControl - Gains Control of the Attached Permanent (Control
+        Magic)
+      - Curse - A Generic Curse the AI has a handful of checks to see
+        what the most appropriate Target is.
+      - Pump - A Generic Pump. The AI has a handful of checks to see
+        what the most appropriate Target is.
+      - ChangeType - For Attachments that change types. Evil Presence is
+        a good example. This logic should be expanded.
+      - KeepTapped - For Attachments that keep a Permanent tapped. The
+        AI will also check for a few things like Vigilance, and another
+        KeepTapped Aura. Paralyzing Grasp is a good example.
+
+Attach separates the actually granting of abilities from the attaching to permanents to streamline how things work.
+
+## BecomeMonarch
+
+## Bond
+
+Soulbonding two creatures. Only used internally by the engine.
+
+## Branch
+Sometimes, an ability might do certain things when a specific condition is true, and other things if not. This can be implemented by using `Branch`.
+The branch evaluates the SVar specified by the property `BranchConditionSVar`, using the comparison defined with `BranchConditionSVarCompare` (such as `GTY`, `LT1`, etc). Depending on whether the condition evaluated to true or false, the subability defined by `TrueSubAbility` or `FalseSubAbility` is executed.
+
+The example below is for "Composer of Spring", which allows either a "land" or a "land or creature" to be put on the battlefield, depending on the number of enchantments in play under your control.
+
+```
+SVar:TrigBranch:DB$ Branch | BranchConditionSVar$ X | BranchConditionSVarCompare$ GE6 | TrueSubAbility$ PutLandCreature | FalseSubAbility$ PutLand
+SVar:PutLand:DB$ ChangeZone | Origin$ Hand | Destination$ Battlefield | Tapped$ True | ChangeType$ Land.YouOwn
+SVar:PutLandCreature:DB$ ChangeZone | Origin$ Hand | Destination$ Battlefield | Tapped$ True | ChangeType$ Creature.YouOwn,Land.YouOwn
+SVar:X:Count$Valid Enchantment.YouCtrl
+```
+
+## Charm
+
+This allows cards that have a mode to be chosen to occur after a trigger.
+
+Parameters
+
+  - CharmNum - Number of Modes to Choose
+  - Choices - A Comma delimited list of SVars containing the Modes
+
+## Choose*
+
+These can be used to chain effects together. However for common cases many effects already support this directly, e.g. `PutCounter | Choices$``.<br>
+Besides making the script shorter using such shortcuts usually also helps the AI making better use of the effect.
+
+### ChooseType
+
+This can be used when you are asked to choose a card type or creature type.
+
+  - Type - Required - Can be Card or Creature
+  - InvalidTypes - Optional - Use to specify any type that cannot be chosen (ex: "Choose any creature type except Wall")
+
+The Defined is for target players.
+
+## Clash
+
+This AF handles clashing. It takes two special parameters: WinSubAbility and
+OtherwiseSubAbility. They are both optional and work the same way,
+namely that it contains the name of an SVar that in turn contains a
+drawback to be executed. The example below is for Release the Ants.
+
+`A:SP$ DealDamage | Cost$ 1 R | Tgt$ TgtCP | NumDmg$ 1 | SubAbility$ DBClash | SpellDescription$ Release the Ants deals 1 damage to target creature or player. Clash with an opponent. If you win, return CARDNAME to its owner's hand.`  
+`SVar:DBClash:DB$ Clash | WinSubAbility$ DBReturn`  
+`SVar:DBReturn:DB$ ChangeZone | Defined$ Self | Origin$ Stack | Destination$ Hand`
+
+## Cleanup
+
+A non-functional, maintenance AF used for Cleaning up certain Variables before a Spell finishes Resolving.
+
+Parameters
+
+  - ClearRemembered$ (optional) Set to True to clear this card's
+    remembered list. Generally useful for Cards that Remember a card, do
+    something to it, then need to forget it once it's done.
+  - ClearImprinted$ (optional) Set to True to clear the list of
+    imprinted cards.
+  - ClearChosenX$ (optional) Set to True to clear the chosen X value.
+  - ClearTriggered$ (optional) Set to True to clear any delayed triggers
+    produced by this card.
+  - ClearCoinFlips$ (optional) Set to True to clear the remembered coin
+    flip result.
+  - ClearChosenCard$ (optional) Set to True to clear the chosen cards.
+  - ForgetDefined$ (optional) If present, remove the specified cards
+    from this card's remembered list.
+
+## Control
+
+### GainControl
+
+Example: Act of Aggression
+
+`A:SP$ GainControl | Cost$ 3 PR PR | ValidTgts$ Creature.OppCtrl | TgtPrompt$ Select target creature an opponent controls. | LoseControl$ EOT | Untap$ True | AddKWs$ Haste | SpellDescription$ Gain control of target creature an opponent controls until end of turn. Untap that creature. It gains haste until end of turn.`
+
+Parameters:
+
+- NewController(Targeted player, if there is no target player, the
+  default is the ActivatingPlayer)
+- AllValid(all valid types, no targets)
+- LoseControl(LeavesPlay, Untap, LoseControl, EOT(end of turn))
+
+### ControlExchange
+
+### ControlSpell
+
+## Copy*
+
+### CopyPermanent
+
+Copies a permanent on the battlefield.
+
+Parameters:
+
+  - NumCopies - optional - the number of copies to put onto the
+    battlefield. Supports SVar:X:????.
+  - Keywords - optional - a list of keywords to add to the copies
+  - AtEOT - optional
+      - Sacrifice - set to this is copy should be sacrificed at End of
+        Turn
+      - Exile - set to this is copy should be exiled at End of Turn
+
+### CopySpellAbility
+
+Copies a spell on the stack (Twincast, etc.).
+
+## Counter
+
+Countering Spells or Abilities.
+
+`A:SP$ Counter | Cost$ 1 U | TargetType$ Spell | TgtPrompt$ Select target spell | ValidTgts$ Card | UnlessCost$ 3 | SpellDescription$ Counter target spell unless its controller pays 3.`  
+`A:SP$ Counter | Cost$ U | TgtPrompt$ Select target Activated or Triggered Ability | ValidTgts$ Card | TargetType$ Activated,Triggered | SpellDescription$ Counter target activated or triggered ability.`  
+`A:SP$ Counter | Cost$ G | TargetType$ Spell | ValidTgts$ Instant,Aura | TargetValidTargeting$ Permanent.YouCtrl | SpellDescription$ Counter target instant or Aura spell that targets a permanent you control. `
+
+Parameters
+
+  - TargetType - Can be Spell,Activated,Triggered. If more than one,
+    just put a comma in between.
+  - ValidTgts - a "valid" expression for types of source card (if you
+    don't know what it is it's just "Card")
+  - TargetValidTargeting- a "valid" expression for targets of this
+    spell's target
+  - Destination - send countered spell to: (only applies to Spells; ignored for Abilities)
+      - Graveyard (Default)
+      - Exile
+      - TopDeck
+      - Hand
+      - BottomDeck
+      - Shuffle
+
+## Counters*
+
+Factories to handle counters on cards.
+
+### Poison
+
+Poison gives a player the specified number of poison counters.
+
+`A:AB$ Poison | Cost$ B T | ValidTgts$ Player | TgtPrompt$ Select target player | Num$ 2 | SpellDescription$ Target player gets 2 poison counters.`
+
+Parameters:
+
+- Num (required) - the number of poison counters to give
+
+Target is optional and used if available. Defined is optional and used if no Target (defaults to "You").
+
+### PutCounter
+
+Put any type of counter on a game object.
+
+`A:AB$ PutCounter | Cost$ T | CounterType$ CHARGE | CounterNum$1 | SpellDescription$ Put a charge counter on CARDNAME.`  
+`A:SP$ PutCounter | Cost$ G | Tgt$ TgtC | CounterType$ P1P1 | CounterNum$ 1 | SpellDescription$ Put a charge counter on CARDNAME.`
+
+Target is optional. If no Target is provided, the permanent will put counters on itself.
+
+  - CounterType (required) specifies the type of counter and should
+    appear in all caps. It should be one of the values in the Counters
+    enum.
+  - CounterNum (required) specifies how many counters will be put on
+    the chosen card.
+
+### PutCounterAll
+
+Put any type of counter on all valid cards.
+
+  - CounterType (required) specifies the type of counter and should
+    appear in all caps. It should be one of the values in the Counters
+    enum.
+  - CounterNum (required) specifies how many counters will be put on
+    the chosen cards.
+  - ValidCards (required) specifies the cards to add counters to.
+
+### RemoveCounter
+
+Remove any type of counter from a card.
+
+Target is optional. If no Target is provided, the permanent will remove
+counters from itself.
+
+  - CounterType (required) specifies the type of counter and should
+    appear in all caps. It should be one of the values in the Counters
+    enum.
+  - CounterNum (required) specifies how many counters will be removed
+    from the chosen card.
+  - UpTo is optional. If an effect states you may remove "up to X
+    counters", set this to True.
+
+### RemoveCounterAll
+
+Remove any type of counter from all valid cards.
+
+  - CounterType$ (required) specifies the type of counter and should
+    appear in all caps. It should be one of the values in the Counters
+    enum.
+  - CounterNum$ (required) specifies how many counters will be removed
+    from the chosen cards.
+  - ValidCards$ (required) specifies the card to remove counters from.
+
+### Proliferate
+
+No own parameters.
+
+### MoveCounters
+
+Used for cards that Move Counters on Resolution, requiring the Host card
+to have Counters for the Move to occur.
+
+Parameters
+
+  - Source - The Source of the Moving Counters
+  - Defined - The Destination of the Moving Counters
+  - CounterType - The type of counter to move.
+  - CounterNum - The number of counters to move.
+
+## Damage
+
+### DealDamage
+
+Deal damage to a specified player or permanent.
+
+`A:AB$ DealDamage | Cost$ T | Tgt$ TgtCP | NumDmg$ 1 | SpellDescription$ CARDNAME deals 1 damage to target creature or player.` 
+
+NumDmg is required. This is the amount of damage dealt.
+
+### EachDamage
+
+## Debuff
+
+Parameters
+
+  - Keywords
+  - Duration
+
+An AbilityFactory for Removing Keywords, either temporarily or for longer durations.
+
+## Destroy
+
+These APIs handles destruction of cards on the battlefield.
+
+`A:SP$Destroy | Cost$ 1 W W | ValidTgts$ Artifact,Enchantment | TgtPrompt$ Select target artifact or enchantment | SpellDescription$ Destroy target artifact or enchantment.`
+
+## Effect
+
+Effect is an oddball of the AF family. Where usually AFs have similarities to each other to help with AI use, Effect doesn't fall under that jurisdiction. In general, an effect is some type of SA that
+lasts longer than its resolution.
+
+A good example is High Tide. For the rest of the turn, High Tide makes
+all Islands produce an extra mana. It doesn't matter if the Island was
+in play, if it turned into an Island after High Tide was cast, any of that.
+
+`A:SP$ Effect | Cost$ U | Name$ High Tide Effect | Triggers$ IslandTrigger | SVars$ TrigMana | SpellDescription$ Until end of turn, whenever a player taps an Island for mana, that player adds U to his or her mana pool (in addition to the mana the land produces).`  
+`SVar:IslandTrigger:Mode$ TapsForMana | ValidCard$ Island | Execute$ TrigMana | TriggerDescription$ Whenever a player taps an Island for mana, that player adds U to his or her mana pool (in addition to the mana the land produces).`  
+`SVar:TrigMana:AB$Mana | Cost$ 0 | Produced$ U | Amount$ 1`
+
+Effect is most similar to Token as it creates a pseudo-permanent, except
+Effect creates in the command zone rather than the battlefield. It stays
+active there for a set Duration.
+
+Parameters
+
+  - Abilities,Triggers,SVars are comma separated lists which contain
+    SVars that point to the appropriate type that the Effect will gain.
+  - Duration is how long the Effect lasts. Right now, most effects will
+    last Until End of Turn. In the future, they may have other
+    conditions.
+
+Duration$ Permanent for effects that have no specific Duration.
+
+  - Stackable$ False - Most Effects are assumed to be Stackable. By
+    setting the Stackable Flag to False, the AI will know having a
+    second one in play is useless, so will save it's Resource for
+    something else.
+  - Image - a file\_name\_without\_extension (image needs to reside in
+    the tokens directory)
+
+## Explore
+
+## Fight
+
+## Fog
+
+Fog is an ability based on the original Fog spell. "Prevent all combat
+damage that would be dealt this turn." While this could be done with an
+effect, the specialized nature of the AI gives it its own AF.
+
+## Game outcome
+
+### GameDraw
+
+### GameLoss
+
+### GameWin
+
+### RestartGame
+
+Used in the script of *Karn Liberated*
+
+## Goad
+
+## Investigate
+
+## Mana
+
+For lands or other permanent to produce mana.
+
+`A:AB$ Mana | Cost$ T | Produced$ <ManaType> | SpellDescription$ Add W to your mana pool.`
+
+In this example ManaType would be W.
+
+## Manifest
+
+## PermanentState
+
+API for things that alter a permanent's state.
+
+### Phases
+
+### SetState
+
+Changing a cards State. This is mostly for Flip Cards or the Transform mechanic.
+
+### Tap
+
+`A:AB$ Tap | Cost$ R | ValidTgts$ Wall | TgtPrompt$ Select target wall | SpellDescription$ Tap target wall.`
+
+### TapOrUntap
+
+### Untap
+
+`A:AB$ Untap | Cost$ G | ActivationLimit$ 1| SpellDescription$ Untap CARDNAME. Activate this ability only once each turn.`  
+`A:SP$ Untap | Cost$ W | ValidTgts$ Permanent | TgtPrompt$ Select target permanent | SpellDescription$ Untap target permanent.`
+
+Target is optional. If not provided, will untap the permanent with this ability.
+
+## Play
+
+Playing a card or cards as part of SA. The player may have to make a
+choice about which card to play if there are more choices than the
+number of cards to play.
+
+Sunbird's Invocation uses many of the parameters.
+
+Amount - How many cards can be played (a non-negative integer or "All").
+
+Valid - Selection criteria for valid cards from the zone to cast.
+
+ValidSA - Applied after Valid, this will filter based on all spells of the cards.
+
+ValidZone - The zone to look in to determine the valid cards.
+
+ShowCards - Other cards in the zone to show when selecting valid cards.
+
+Optional - Casting the card is optional.
+
+RememberPlayed - Remember the card played.
+
+ForgetRemembered - Remove all remembered cards from the source (but only
+if a card was successfully played)
+
+ForgetTargetRemembered - Remove the played card from remembered cards
+(but only if it was successfully played)
+
+WithoutManaCost - The card can be cast without mana payment.
+
+## PreventDamage
+
+AF damage prevention effects.
+
+      - A:SP$ PreventDamage | Cost$ W | ValidTgts$ Creature | Amount$ 3
+        | TgtPrompt$ Select target creature | SpellDescription$ Prevent
+        the next 3 damage that would be dealt to target creature this
+        turn.
+
+## Protection
+
+Protection grants protection from colors or cards types, or creature
+types. Anything that has "Protection from ..."
+
+Gains - required - the thing to gain protection from (green, artifacts,
+Demons, etc.) or "Choice" if you can choose one of...
+
+Choices - optional
+- if Gains$ Choice then this is a comma-delimited list of choices
+
+## Pump
+
+This factory handles pumping creatures power/toughness or granting abilities to permanents (usually creatures).
+
+      - A:AB$ Pump | Cost$ R | NumAtt$ +1 | SpellDescription$ CARDNAME
+        gets +1/+0 until end of turn.
+      - A:SP$ Pump | Cost$ 1 U | ValidTgts$ Creature | KW$ Shroud|
+        SpellDescription$ Target creature gains shroud until end of
+        turn. | TgtPrompt$ Select target creature.
+
+Target is optional. If it's not provided, the activating permanent will be pumped.
+
+NumAtt$ is optional, will pump Power.
+
+NumDef$ is optional, will pump Toughness.
+
+KW$ is optional, will give temporary keywords.
+
+## Regenerate
+
+Regenerate is similar to abilities like Pump. But for creating
+Regeneration shields.
+
+      - A:AB$ Regenerate | Cost$ B | SpellDescription$ Regenerate
+        CARDNAME
+      - A:SP$ Regenerate | Cost$ W | ValidTgts$ Creature | TgtPrompt$
+        Select target creature | SpellDescription$ Regenerate target
+        creature.
+
+Target is optional. If not provided, will regenerate the permanent with this ability.
+
+## Repeat
+
+Repeat the specified ability.
+
+### Repeat
+
+`A:SP$ Repeat | Cost$ 3 B B | RepeatSubAbility$ DBDig | RepeatOptional$ True`
+
+  - MaxRepeat - optional - the maxium times to repeat, execute repeat
+    ability at least once
+  - RepeatSubAbility - required - setup subability to repeat
+  - RepeatOptional - optional - you make the choice whether to repeat
+    the process
+  - RepeatPresent, RepeatCompare, RepeatDefined, RepeatCheckSVar,
+    RepeatSVarCompare - optional - condition check
+
+### RepeatEach
+
+  - RepeatSubAbility - required - to set up repeat subability
+  - RepeatCards - to repeat for each valid card (zone: present zone of
+    the valid repeat cards, default: battlefield)
+  - DefinedCards
+  - RepeatPlayers - to repeat for each valid player
+  - RepeatCounters - to repeat for each valid counters
+
+## Reveal
+
+### RevealHand
+
+Look at a player's hand.
+
+Target or Defined is required.
+
+`A:AB$ RevealHand | Cost$ T | ValidTgts$ Player | TgtPrompt$ Select target player | SpellDescription$ Look at target player's hand.`
+
+### Reveal
+
+`A:AB$ Reveal | Cost$ 2 U T | Defined$ You | RevealValid$ Card.Blue | AnyNumber$ True | RememberRevealed$ True`
+
+Parameters:
+
+  - RevealValid: to limit the valid cards.
+  - AnyNumber
+  - Random
+  - RememberRevealed: to remember the cards revealed
+
+### PeekAndReveal
+
+This AF is very similar to things that Dig can do, but handle a much
+simpler form, with less complex coding underneath. Similar to how
+RearrangeTopOfLibrary could be handled with Dig.
+
+Primarily used with cards that allow you to Peek at the top card of your
+library, and allow you to reveal it if it's of a certain type. The
+Kinship cards fit this bill perfectly, so they are used to simplify the
+complex popups that would be required if using multiple Dig
+SubAbilities.
+
+RevealOptional - Whether or not the Reveal is optional.
+
+RememberRevealed - Whether to remember the revealed cards (after
+filtering by Valid)
+
+RememberPeeked - Whether to remember the peeked cards (only if they are
+not revealed\!)
+
+RevealValid - defaults to Card, but allows you to set a specific
+ValidType if you can only have certain things
+
+PeekAmount - defaults to 1, but allows you to peek at multiple cards if
+possible
+
+## RollDice
+
+## Sacrifice
+
+Usually you choose a player and that player has to sacrifice something
+
+`A:SP$ Sacrifice | Cost$ 1 B | ValidTgts$ Player | SacValid$ Creature | SacMessage$ Creature | Amount$ 2 | SpellDescription$ Target player sacrifices a creature.`
+
+Destroy$ True - An optional parameter for destroying permanents target
+player chooses (eg: Burning of Xinye, or Imperial Edict).
+
+`A:SP$ Sacrifice | Cost$ 1 B | ValidTgts$ Opponent | SacValid$ Creature | SacMessage$ Creature | Destroy$ True | SpellDescription$ Target opponent chooses a creature he or she controls. Destroy it.`
+
+## Scry
+
+`A:AB$ Scry | Cost$ 1 T | ScryNum$ 2`
+
+## StoreSVar
+
+## Token
+
+Token simply lets you create tokens of any type.
+
+`A:SP$ Token | Cost$ 3 W U | TokenImage$ W 1 1 Bird Flying | TokenAmount$ X | TokenName$ Bird | TokenTypes$ Creature,Bird | TokenOwner$ You | TokenColors$ Blue | TokenPower$ 1 | TokenToughness$ 1 | TokenKeywords$ Flying`
+
+This ability factory does not take a target. All the parameters are
+mandatory except for TokenKeywords. If you provide a non-integer for
+TokenAmount, TokenPower or TokenToughness the AF will attempt to look for
+an SVar of that name and interpret it's contents as a Count$ line. Worth
+noting is that TokenTypes and TokenColors are simple commaseparated
+lists while TokenKeywords is a list where the items are separated by
+"\<\>". If TokenImage is not provided, the factory will attempt to
+construct a filename on it's own. TokenOwner can use Defined-like
+parameters, such as "You" "Opponent" or the new Triggered-Variables.
+
+You can also use the parameters TokenAbilities$, TokenTriggers$ and
+TokenSVars$ to give the created tokens any number of either. For
+example, here's how Growth Spasm creates an Eldrazi Spawn token complete
+with ability.
+
+    SVar:DBToken:DB$Token | TokenAmount$ 1 | TokenName$ Eldrazi Spawn | TokenTypes$ Creature,Eldrazi,Spawn | TokenOwner$ You | TokenColors$ Colorless | TokenPower$ 0 | TokenToughness$ 1 | TokenAbilities$ ABMana SVar:ABMana:AB$Mana | Cost$ Sac<1/CARDNAME> | Produced$ 1 | Amount$ 1 | SpellDescription$ Add 1 to your mana pool. 
+
+As another example, here's Mitotic Slimes' use of TokenTriggers$:
+
+    T:Mode$ ChangesZone | Origin$ Battlefield | Destination$ Graveyard | ValidCard$ Card.Self | Execute$ TrigTokenSenior | TriggerDescription$ When CARDNAME is put into a graveyard from the battlefield, put two 2/2 green Ooze creature tokens onto the battlefield. They have "When this creature is put into a graveyard, put two 1/1 green Ooze creature tokens onto the battlefield." 
+    SVar:TrigTokenSenior:AB$ Token | Cost$ 0 | TokenImage$ g 2 2 ooze | TokenName$ Ooze | TokenTypes$ Creature,Ooze | TokenColors$ Green | TokenOwner$ You | TokenPower$ 2 | TokenToughness$ 2 | TokenAmount$ 2 | TokenTriggers$ TriggerJunior | TokenSVars$ TrigTokenJunior 
+    SVar:TriggerJunior:Mode$ ChangesZone | Origin$ Battlefield | Destination$ Graveyard | ValidCard$ Card.Self | Execute$ TrigTokenJunior | TriggerDescription$ When this creature is put into a graveyard, put two 1/1 green Ooze creature tokens onto the battlefield. SVar:TrigTokenJunior:AB$Token | Cost$ 0 | TokenImage$ g 1 1 ooze | TokenName$ Ooze | TokenTypes$ Creature,Ooze | TokenColors$ Green | TokenOwner$ You | TokenPower$ 1 | TokenToughness$ 1 | TokenAmount$ 2 
+
+## Trigger
+
+If possible split the SpellDescription$ of the the effect so the part for the trigger can become the StackDescription directly.
+
+### DelayedTrigger
+
+### ImmediateTrigger
+
+## Turn structure
+
+### AddPhase
+
+### AddTurn
+
+`A:SP$ AddTurn | Cost$ 1 U | NumTurns$ 1 | SpellDescription$ Take an extra turn after this one.`
+
+### EndTurn
+
+### ReverseTurnOrder
+
+### SkipPhase
+
+### SkipTurn
+
+## ZoneAffecting
+
+For specific effects that handle zones in a specific manner
+
+### ChangeZone
+
+ChangeZone is a united front of any card that changes zone. This does
+not include: drawing, discarding, destroying, or milling, as these
+represent specific words on which triggers and replacements can react.
+There are two primary forms, but the distinction is handled mostly in
+the codebase. The only thing that is required is to set appropriate parameters.
+
+Origin and Destination are both required.
+
+Origin is where the card is coming from.
+
+Destination is where the card is going to. If Destination is Library, a
+LibraryPosition is recommended, but not required. **Default value of the
+LibraryPosition is 0.** 0 represents the top of the library, -1 represents the bottom.
+
+There are two primary versions of ChangeZone.
+
+#### Hidden Origin
+
+The first is hidden, generally used for Origin zones that are not known
+information, like the Library or the Hand. The choice of "What card is
+changing zones?" happens during resolution.
+
+`A:SP$ ChangeZone | Cost$ W | Origin$ Library | Destination$ Library | LibraryPosition$ 0 | ChangeType$ Artifact,Enchantment | ChangeNum$ 1 | SpellDescription$ Search your library for an artifact or enchantment card and reveal that card. Shuffle your library, then put the card on top of it.`  
+`A:AB$ ChangeZone | Cost$ T | Origin$ Hand | Destination$ Battlefield | ChangeType$ Land | ChangeNum$ 1 | Optional$ True | SpellDescription$ You may put a land card from your hand onto the battlefield.`
+
+For Hidden, things like ChangeType and ChangeNum are used to restrict
+what can ChangeZone, and how many do. There are two parameters special
+to Hidden Origin:
+
+"Chooser" defines which player has to decide which card changes zone
+(example You, Opponent).
+
+"Mandatory" most of these abilities are not mandatory, but some are.
+
+#### Known Origin
+
+The second is known, generally used for Origin zones that are known
+information, like the Battlefield or the Graveyard. The choice of "What
+card is changing zones?" happens on activation, generally by targeting.
+
+`A:AB$ ChangeZone | Cost$ 1 U T | TgtPrompt$ Choose target artifact card in your graveyard | ValidTgts$ Artifact.YouCtrl | Origin$ Graveyard | Destination$ Library | SpellDescription$ Put target artifact card from your graveyard on top of your library.`  
+`A:SP$ ChangeZone | Cost$ U U | ValidTgts$ Permanent | TgtPrompt$ Select target permanent | Origin$ Battlefield | Destination$ Hand | SpellDescription$ Return target permanent to its owner's hand.`
+
+For Known, since it just uses Target, normal target parameters are used in this Scenario.
+
+### ChangeZoneResolve
+
+This is a helper AF, for chained effects that create multiple permanents which should enter the battlefield at the same time.
+
+To use it, you need to set the param "ChangeZoneTable" on the first effect and then call this at the end.
+
+This is supported by the following effects:
+- Amass
+- CopyPermanent
+- RepeatEach (_NOTE: if you wrap the creation, you don't need to call this AF on its own_)
+- Token
+
+### Dig
+
+Dig is for an ability that does basically this: "You look at the X cards
+of your Library, put Y of them somewhere, then put the rest somewhere."
+Think of Impulse.
+
+- DigNum - Required - look at the top number of cards of your library.
+- Reveal - Optional - for abilities that say "Reveal the top X cards
+  of your library". Default is false.
+- SourceZone - Optional - the zone to dig in. Default is Library.
+- DestinationZone - Optional - the zone to put the Y cards in. Default
+  is Hand.
+- LibraryPosition - Optional - if DestinationZone is Library, use this
+  to specify position. Default is -1 (bottom of library).
+- ChangeNum - Optional - the number of cards to move to the
+  DestinationZone (or "All" when it's for things like "put all lands
+  revealed this way into your hand"). Default is 1.
+- ChangeValid - Optional - use this to specify if "you may move an
+  artifact to DestinationZone". Default is any Card.
+- AnyNumber - Optional - use if you can move any number of Cards to
+  DestinationZone. Default is false. (think of Lead the Stampede)
+- Optional - Optional - set this if you "may" move a card to
+  DestinationZone. Default is false.
+- DestinationZone2 - Optional - the zone to put the rest of the cards
+  in. If it is library, you are prompted for the order. Default is
+  Library.
+- LibraryPosition2 - Optional - if DestinationZone2 is Library, use
+  this to specify position. Default is -1 (bottom of library).
+
+### DigUntil
+
+### Discard
+
+`A:AB$ Discard | Cost$ T | ValidTgts$ Opponent | NumCards$ 1 | Mode$ TgtChoose | SpellDescription$ Target opponent discards a card. `
+
+  - NumCards - the number of cards to be discarded (may be integer or X)
+  - Mode - the mode of discard - should match spDiscard
+      - Random
+      - TgtChoose
+      - RevealYouChoose
+      - Hand
+  - DiscardValid - a ValidCards syntax for acceptable cards to discard
+  - UnlessType - a ValidCards expression for "discard X unless you
+    discard <Type>"
+
+### Draw
+
+`A:AB$ Draw | Cost$ 1 Sac<1/CARDNAME> | NumCards$ 1 | SpellDescription$ Draw a card.`
+
+### Mill
+
+`A:AB$ Mill | Cost$ 2 T | NumCards$ 2 | ValidTgts$ Player | TgtPrompt$ Choose a player to mill | SpellDescription$ Target player puts the top two cards of his or her library into his or her graveyard.`
+
+### RearrangeTopOfLibrary
+
+### Shuffle
+
+Used for shuffling a player's library
+
+  - Optional - Set this parameter if the user should be
+    prompted Yes/No to shuffle the given library. Default is false.
+
+### TwoPiles
+
+## Vote

docs/Card-scripting-API/Card-scripting-API.md

@@ -0,0 +1,356 @@
+A reference guide for scripting cards using the API parsed by the Forge engine.
+
+# Base Structure
+
+By opening any file in the /res/cardsfolder folder you can see the basic structure of how the data is created.<br>
+Here's an example of a vanilla creature:
+
+```
+Name:Vanilla Creature
+ManaCost:2 G
+Types:Creature Beast
+PT:2/2
+Oracle:
+```
+
+The name of this card is Vanilla Creature.<br>
+It's casting cost is {2}{G}.<br>
+It has the types Creature and Beast.<br>
+It has a Power-Toughness of 2/2.<br>
+It will not display any additional text in the card's template.<br>
+
+If a card has two faces, use AlternateMode:{CardStateName} in the front face and separate both by a new line with the text "ALTERNATE".
+
+There are a few other properties that will appear in many cards. These are
+
+| Property | Description
+| - | -
+|`A`|[Ability effect](AbilityFactory)
+|`AI`|RemoveDeck:<br />* `All`<br />This will prevent the card from appearing in random AI decks. It is applicable for cards the AI can't use at all like Dark Ritual and also for cards that the AI could use, but only ineffectively like Tortoise Formation. The AI won't draft these cards.<br />* `Random`<br /> This will prevent the card from appearing in random decks. It is only applicable for cards that are too narrow for random decks like Root Cage or Into the North. The AI won't draft these cards.<br />* `NonCommander`<br /> 
+|`Colors`|Color(s) of the card<br /><br />When a card's color is determined by a color indicator rather than shards in a mana cost, this property must be defined. If no identifier is needed, this property should be omitted.<br /><br />* `Colors:red` - This is used on Kobolds of Kher Keep, which has a casting cost of {0} and requires a red indicator to make it red.<br /><br />* `Colors:red,green` - Since Arlinn, Embraced by the Moon has no casting cost (it's the back of a double-faced card), the red and green indicator must be included.
+|`DeckHints`|AI-related hints for a deck including this card<br /><br />To improve synergy this will increase the rank of of all other cards that share some of its DeckHints types. This helps with smoothing the selection so cards without these Entries won't be at an unfair disadvantage.<br /><br />The relevant code can be found in the [CardRanker](https://git.cardforge.org/core-developers/forge/-/blob/master/forge-gui/src/main/java/forge/gamemodes/limited/CardRanker.java) class.
+|`DeckNeeds`|This can be considered a stronger variant when the AI should not put this card into its deck unless it has whatever other type is specified. The way this works is "inverted": it will directly decrease the rank of the card unless other cards are able to satisfy its types.<br />If a card demands more than one kind of type you can reuse it:<br />`DeckNeeds:Type$Human & Type$Warrior` will only find Human Warrior compared to `DeckNeeds:Type$Human\|Warrior` which is either
+|`DeckHas`|specifies that the deck now has a certain ability (like, token generation or counters) so that the drafting/deckbuilding AI knows that it now meets requirements for DeckHints/DeckNeeds. This is actually very useful since many of these (such as `Ability$Graveyard, Ability$Token, Ability$Counters`) are not deduced by parsing the abilities, so an explicit hint is necessary. Using the other types is also supported in case the implicit parsing wouldn't find it.<br />It doesn't require exact matching to have an effect but cards that care about multiple entries for a given type will be judged higher if a card seems to provide even "more" synergy for it.<br />Example:<br />Chishiro has two abilities so `DeckHas:Ability$Token & Ability$Counters` is used, therefore score for `DeckNeeds:Ability$Token\|Counters` is increased
+|`K`|Keyword (see below)
+|`Loyalty`|Number of starting loyalty counters
+|`ManaCost`|Cost to cast the card shown in mana shards<br /><br />This property is required. It has a single parameter that is a mana cost.<br /><br />* `ManaCost:no cost` for cards that cannot be cast<br />* `ManaCost:1 W W` sets the casting cost to {1}{W}{W}
+|`Name`|Name of the card<br /><br />A string of text that serves as the name of the card. Note that the registered trademark symbol cannot be included, and this property must have at least one character.<br /><br />Example:<br />* `Name:A Display of My Dark Power` sets the card's name to "A Display of My Dark Power"
+|`Oracle`|The current Oracle text used by the card.<br /><br />We actually have a Python Script that runs to be able to fill in this information, so don't worry about manually editing a lot of cards when Wizards decides to change the rules. <br /><br />This field is used by the Deck Editor to allow non-Legendary Creatures to be marked as potential commanders. Make sure "CARDNAME can be your commander." appears in the oracle text.
+|`PT`|Power and toughness
+|`R`|[Replacement effect](Replacements)
+|`S`|[Static ability](static-abilities)
+|`SVar`|String variable. Used throughout scripting in a handful of different ways.
+|`T`|[Triggered ability](Triggers)
+|`Text`|Additional text that needs to be displayed on the CardDetailPanel that doesn't have any spell/ability that generates a description for it, for example "CARDNAME can be your commander." or "X can't be 0.".
+|`Types`|Card types and subtypes<br /><br />Include all card types and subtypes, separated by spaces.<br /><br />Example:<br />* `Types:Enchantment Artifact Creature Golem` for a card that reads Enchantment Artifact Creature -- Golem
+
+Rarity and Set info are now defined in edition definition files. These can be found at /res/reditions path.
+
+## Conventions
+- filename: all lowercase, skip special characters, underscore for spaces
+- Unix(LF) line endings
+- use empty lines only when separating multiple faces on a card
+- try to avoid writing default params to keep scripts concise
+  - e.g. just `SP$ Draw` instead of `SP$ Draw | Defined$ You | NumCards$ 1`
+
+# Keywords
+
+All keywords need to be prepended with "K:" to be parsed correctly. Each keyword must appear on a separate line.
+
+## Keywords without Parameters
+
+This section is for Keywords that require no additional parameters and are one or two words long. Most of these you would see exactly on cards in the game.<br>
+Examples:
+
+- Cascade
+- Changeling
+- Cipher
+- Conspire
+- Convoke
+- Deathtouch
+- Defender
+- Delve
+- Devoid
+- Double Strike
+- Epic
+- Exalted
+- Fear
+- First Strike
+- Flanking
+- Flash
+- Flying
+- Forestwalk
+- Fuse
+- Haste
+- Hideaway
+- Horsemanship
+- Indestructible
+- Infect
+- Intimidate
+- Islandwalk
+- Landfall
+- Legendary landwalk
+- Lifelink
+- Living Weapon
+- Menace
+- Mentor
+- Mountainwalk
+- Nonbasic landwalk
+- Persist
+- Plainswalk
+- Prowess
+- Provoke
+- Reach
+- Rebound
+- Retrace
+- Riot
+- Shadow
+- Shroud
+- Snow forestwalk
+- Snow islandwalk
+- Snow landwalk
+- Snow mountainwalk
+- Snow plainswalk
+- Snow swamp walk
+- Soulbond
+- Split second
+- Storm
+- Sunburst
+- Swampwalk
+- Totem Armor
+- Trample
+- Unblockable
+- Undying
+- Vigilance
+- Wither
+
+## Keywords with parameters
+
+- Adapt:{cost}
+- AdjustLandPlays:{params}
+- Afterlife:{N}
+- AlternateAdditionalCost:{cost}
+- Amplify:{cost}:{validType(comma separated)}
+- Annihilator:{magnitude}
+- Bloodthirst:{magnitude}
+- Bestow:{cost}
+- Bushido:{magnitude}
+- CantBeBlockedByAmount {xMath}
+- Champion:{validType}
+- CostChange:{params}
+- Crew:{cost}
+- Cumulative upkeep:{cost}:{Description}
+- Cycling:{cost}
+- Dash:{cost}
+- Devour:{magnitude}
+- Dredge:{magnitude}
+- Echo:{cost}
+- Emerge:{cost}
+- Enchant {params} \[Curse\]
+- Enchant {Type}
+- Entwine:{cost}
+- Equip:{cost}
+- etbCounter:{CounterType}:{CounterAmount}
+- ETBReplacement:{Control/Copy/Other}:{AbilitySVar}\[:Optional\]
+- Evoke:{cost}
+- Fabricate:{cost}
+- Fading:{FadeCounters}
+- Flashback:{cost}
+- Foretell:{cost}
+- Fortify:{cost}
+- Graft:{value}
+- Haunt:{ability}:{Description}
+- Hexproof:{ValidCards}:{Description}
+- Kicker:{cost}
+- Level up:{cost}
+- Madness:{cost}
+- ManaConvert:
+- maxLevel:{magnitude}
+- MayEffectFromOpeningHand:{Effect}
+- Miracle:{cost}
+- Modular:{magnitude}
+- Monstrosity:{cost}
+- [Mega]Morph:{cost}
+- Multikicker:{magnitude}
+- Mutate:{cost}
+- Ninjutsu:{cost}
+- Outlast:{cost}
+- Partner:{CardName}
+- Poisonous {magnitude}
+- PreventAllDamageBy {ValidCards}
+- Protection:{ValidCards}:{Description}
+- Prowl:{cost}
+- Rampage:{magnitude}
+- Recover:{cost}
+- Renown:{N}
+- Replicate:{cost}
+- Ripple:{magnitude}
+- Soulshift:{magnitude}
+- Strive:{cost}
+- Suspend:{turns}:{cost}
+- Transmute:{cost}
+- Toxic:{poisonCounters}
+- TypeCycling:{Type}:{cost}
+- Unearth:{cost}
+- UpkeepCost:{cost}
+- Vanishing:{TimeCounters}
+
+## Plaintext keywords
+
+These are hardcoded but not truly keywords rules-wise and will eventually be turned into static abilities.
+Only listing the most common ones here so you can recognize them.
+CARDNAME is replaced by the card's name ingame.
+
+- All creatures able to block CARDNAME do so.
+- CARDNAME assigns no combat damage
+- CARDNAME attacks each turn if able.
+- CARDNAME attacks each combat if able.
+- CARDNAME blocks each combat if able.
+- CARDNAME blocks each turn if able.
+- CARDNAME can attack as though it didn't have defender.
+- CARDNAME can attack as though it had haste.
+- CARDNAME can block as though it were untapped.
+- CARDNAME can block creatures with shadow as though they didn't have shadow.
+- CARDNAME can block creatures with landwalk abilities as though they didn't have those abilities.
+- CARDNAME can block only creatures with flying.
+- CARDNAME can only attack alone.
+- CARDNAME can't attack.
+- CARDNAME can't attack if you cast a spell this turn.
+- CARDNAME can't attack if defending player controls an untapped creature with power {rest of text string}
+- CARDNAME can't attack or block.
+- CARDNAME can't attack or block alone.
+- CARDNAME can't be countered.
+- CARDNAME can't be enchanted.
+- CARDNAME can't be equipped.
+- CARDNAME can't be regenerated.
+- CARDNAME can't be the target of Aura spells.
+- CARDNAME can't block.
+- CARDNAME can't block creatures with power {rest of text string}
+- CARDNAME can't block unless a creature with greater power also blocks.
+- CARDNAME can't block unless at least two other creatures block.
+- CARDNAME can't transform
+- CARDNAME doesn't untap during your untap step.
+- CARDNAME enters the battlefield tapped.
+- CARDNAME is {color}.
+- CARDNAME must be blocked if able.
+- CARDNAME must be blocked by exactly one creature if able.
+- CARDNAME must be blocked by two or more creatures if able.
+- CARDNAME can't be blocked unless all creatures defending player controls block it.
+- CARDNAME's power and toughness are switched
+- CARDNAME untaps during each other player's untap step.
+- CARDNAME's activated abilities can't be activated.
+- Creatures with power greater than CARDNAME's power can't block it.
+- Creatures can't attack unless their controller pays:{params}
+- Damage that would be dealt by CARDNAME can't be prevented.
+- Damage that would reduce your life total to less than 1 reduces it to 1 instead.
+- Enchant artifact
+- Enchant creature
+- Enchant creature with converted mana cost 2 or less
+- Enchant creature without flying
+- Enchant red or green creature
+- Enchant land
+- Enchant land you control
+- Enchant tapped creature
+- No more than one creature can attack each combat.
+- No more than one creature can block each combat.
+- No more than two creatures can attack you each combat.
+- No more than two creatures can block each combat.
+- Play with your hand revealed.
+- Prevent all combat damage that would be dealt to and dealt by CARDNAME.
+- Prevent all combat damage that would be dealt by CARDNAME.
+- Prevent all combat damage that would be dealt to CARDNAME.
+- Prevent all damage that would be dealt to and dealt by CARDNAME.
+- Prevent all damage that would be dealt by CARDNAME.
+- Prevent all damage that would be dealt to CARDNAME.
+- Protection from {type}
+- Remove CARDNAME from your deck before playing if you're not playing for ante.
+- Spells and abilities your opponents control can't cause you to sacrifice permanents.
+- You can't pay life to cast spells or activate abilities.
+- You can't sacrifice creatures to cast spells or activate abilities.
+- You can't draw cards.
+- You can't gain life.
+- You can't lose the game.
+- You can't win the game.
+- You don't lose the game for having 0 or less life.
+- You may choose not to untap CARDNAME during your untap step.
+- You may have CARDNAME assign its combat damage as though it weren't blocked.
+- Your life total can't change.
+
+# General SVars
+
+`SVar:SoundEffect:goblinpolkaband.mp3`
+
+The sound system supports a special SVar that defines the sound that should be played when the spell is cast.
+
+`SVar:X:Count$`
+
+Count is our general value computation function. It's quite varied with a lot of different things it can calculate and is often being updated.
+
+# AI specific SVars
+
+`SVar:AIPreference:SacCost$Creature.token,Creature.cmcLE2`
+
+`SVar:AntiBuffedBy:[ValidCards]`
+
+If a permanent with this SVar is on the battlefield under human control
+the AI will play the specified cards in Main1. Applicable for cards like
+Heart Sliver or Timid Drake.
+
+`SVar:BuffedBy:[ValidCards]`
+
+If a permanent with this SVar is on the battlefield under its control
+the AI will play the specified cards in Main1. Applicable for creatures
+with a P/T setting static ability (Kithkin Rabble) or additional buffes
+(Radiant, Archangel).
+
+`SVar:EnchantMe:[Multiple]/[Once]`
+
+Creatures with "Multiple" in this SVar will always be prefered when the
+AI enchants (Rabid Wombat), creatures with "Once" only if they are not
+enchanted already (Gate Hound).
+
+`SVar:EquipMe:[Multiple]/[Once]`
+
+Creatures with "Multiple" in this SVar will always be prefered when the
+AI equippes (Myr Adapter), creatures with "Once" only if they are not
+equipped already (Kor Duelist).
+
+`SVar:AIEvaluationModifier:[ValidAmount]`
+
+`SVar:EndOfTurnLeavePlay:True`
+
+`SVar:maxLevel:`
+
+`SVar:HasCombatEffect:True`
+
+`SVar:HasAttackEffect:True`
+
+`SVar:HasBlockEffect:True`
+
+`SVar:MustAttack:True`
+
+`SVar:MustBeBlocked:True`
+
+`SVar:NeedsToPlayVar:[ValidCards]`
+
+`SVar:ManaNeededToAvoidNegativeEffect:`
+
+`SVar:NonStackingEffect:True`
+
+`SVar:PlayMain1:TRUE/ALWAYS/OPPONENTCREATURES`
+
+The AI will play cards with this SVar in its first main phase. Without other AILogic, it will usually not play any permanents without this in Main1.
+
+`SVar:SacMe:[number]`
+
+The AI will sacrifice these cards to pay costs. The higher the number the higher the priority. Example: Hatching Plans has SVar:SacMe:5.
+
+`SVar:Targeting:Dies`
+
+`SVar:UntapMe:True`
+
+The AI will prioritize untapping of this card.
+
+`SVar:AIUntapPreference:`
+
+`SVar:NoZeroToughnessAI:True`

docs/Card-scripting-API/Costs.md

@@ -0,0 +1,186 @@
+Cost is a class that attempts to streamline costs throughout all cards. It requires that each cost is separated by a space. I will use examples that could be found in Ability, although certain Keyworded abilities do use Cost too.
+
+# Common
+
+## Description
+
+Description is an optional last parameter in the cost. This is to allow
+for complex Type definitions to have a nice Description that is readable.
+
+## CostDesc / PrecostDesc
+
+## UnlessCost
+
+UnlessCost allows the player specified with UnlessPayer (same as
+Defined, defaults to TargetedController) to pay mana to prevent the
+resolving of the ability. If the script has the param "UnlessSwitched",
+then the player pays mana to resolve the ability (usually used to handle
+"any player may pay ..." ).
+
+## XChoice
+
+XChoice is the variable that basically means "You can choose whatever
+you want for this variable. But you need to decide what X is before you
+start paying." This would commonly appear as an SVar definition of X.
+
+## xPaid
+
+xPaid is the amount of Mana Paid for an X Cost. There are a few cards
+that will use the X Payment to determine other costs (like Abandon Hope)
+This would commonly appear as an SVar definition of X.
+
+## CARDNAME
+
+For Costs that do something to themselves (ex. Discard Self, Sacrifice
+Self)
+
+# Types of Cost
+
+## Discard
+
+Discard has two required parameters and one optional in the form
+Discard<Num/Type/Description>
+
+-   The first is how many cards are being discarded.
+-   The second is what card types can be discarded. (Hand for the whole
+    hand, Random for chosen randomly)
+
+## Draw
+
+## Exert
+
+## Exile
+
+Exile has two required parameters and one option in the form of
+Exile<Num/Type/Description>
+
+There are also a few sister abilities that all fit under the Exile
+umbrella.
+
+-   Exile (for cards on the Battlefield)
+-   ExileFromGraveyard
+-   ExileFromHand
+-   ExileFromTop (for cards on top of your library, this doesn't default
+    Type to Card, so make sure you add it)
+
+Some Examples
+
+-   Exile&lt;1/Creature&gt;
+-   Exile&lt;1/CARDNAME&gt;
+-   ExileFromHand&lt;1/CARDNAME&gt;
+-   ExileFromHand&lt;2/Creature&gt;
+-   ExileFromGrave&lt;1/CARDNAME&gt;
+-   ExileFromGrave&lt;1/Treefolk&gt;
+-   ExileFromTop&lt;10/Card&gt;
+
+## FlipCoin
+
+Only used by "Karplusan Minotaur".
+
+## Mana
+
+-   Cost$ 2
+    -   2 colorless mana
+-   Cost$ B R
+    -   1 black and 1 red mana
+-   Cost$ WG
+    -   Hybrid White/Green mana
+-   Cost$ S
+    -   Snow Mana
+-   Cost$ Mana&lt;2\\Creature&gt;
+    -   2 colorless produced by a source with type 'creature'. Note the
+        backslash - it was chosen because hybrid costs already use slash
+
+Here's some examples:
+
+-   Discard&lt;1/Card&gt;
+    -   "Discard 1 Card"
+-   Discard&lt;0/Hand&gt; (The number is ignored when Hand is used as a
+    type.)
+    -   Discard your hand
+-   Discard&lt;2/Random&gt;
+    -   Discard 2 Cards at Random
+-   Discard&lt;1/CARDNAME&gt;
+    -   Discard Self (CARDNAME)
+-   Discard&lt;1/Creature.Black/Black Creature&gt;
+    -   Discard 1 Black Creature
+
+## Mill
+
+## Subtract(Remove) Counter
+
+SubCounter has two required parameters in the form of
+SubCounter<Num/CounterName>
+
+-   SubCounter&lt;2/P1P1&gt;
+-   SubCounter&lt;1/CHARGE&gt;
+
+Remember the token name should appear all in caps.
+
+As third parameter you can use a ValidCard.
+
+## Sacrifice
+
+Sacrifice has two required parameters and one optional parameter in the
+form of Sac<Num/Type/Description>
+
+-   Sac&lt;1/Artifact&gt;
+-   Sac&lt;1/CARDNAME&gt;
+
+## Tap
+
+-   Cost$ T
+
+## Untap
+
+-   Cost$ Untap
+
+\- or -
+
+-   Cost$ Q
+
+## Unattach
+
+## PayEnergy
+
+## PayLife
+
+PayLife has one required parameter in the form of PayLife<Num>
+
+-   PayLife&lt;2&gt;
+
+## GainLife
+
+## TapXType
+
+TapXType has two required parameters and one option in the form of
+tapXType<Num/Type/Description>
+
+-   tapXType&lt;3/Creature.White&gt;
+
+## Return
+
+Return has two required parameters and one optional in the form of
+Return<Num/Type/Description>
+
+-   Return&lt;1/Land&gt;
+-   Return&lt;1/CARDNAME&gt;
+
+## Reveal
+
+# Putting it Together
+
+Putting it together is pretty simple. If a card needs to pay mana and tap, it would look like this:
+
+-   Cost$1 W T
+
+For a spell that has an additional cost of sacrificing a land, put the
+mana cost and the additional cost in the cost:
+
+-   Cost$2 G Sac&lt;1/Land&gt;
+
+One of the features of Cost is you can have more than one of the same Cost type:
+
+-   Cost$ Sac&lt;1/Swamp&gt; Sac&lt;1/Creature&gt;
+
+There are many examples, but they mostly fall into those categories.

docs/Card-scripting-API/Replacements.md

@@ -0,0 +1,90 @@
+Replacement create replacement effects, as you'd expect. Their script
+follows the format introduced by AbilityFactory; simply begin a line
+with "R:", to indicate that it's for a replacement effect, followed by a
+collection of name-value pairs (name and value are separated by $)
+separated by pipes (|). All Replacement effects expect an "Event$"
+parameter, which declares what event should be replaced. Most replacement effects will also have a "ReplaceWith$" parameter which points to an SVar which contains what should replace the event. They may have a "Prevent$True" parameter, instead though, which means that nothing happens instead of the event.
+
+Similarly to triggers, the replacing code can access special variables
+pertaining to the event it replaced (like triggered-variables). These
+are specific to each event, and is listed below. Most replacement effects
+will also have a "Description$" parameter which is simply the card text
+for the ability.
+
+## DamageDone
+
+DamageDone events are checked when damage is about to be assigned to a
+card or player. There are 5 special parameters:
+
+  - ValidSource - The damage source must match this for the event to be
+    replaced.
+  - ValidTarget - The damage target must match this for the event to be
+    replaced.
+  - DamageAmount - The amount of damage must match this.
+  - IsCombat - If true, the damage must be combat damage, if false, it
+    can't be.
+  - IsEquipping - If true, the host card must be equipping something.
+
+There are 3 Replaced-variables:
+
+  - DamageAmount - The amount of damage to be assigned.
+  - Target - The target of the damage.
+  - Source - The source of the damage.
+
+## Discard
+
+Discard events are checked when a player is about to discard a card.
+There are 4 special parameters:
+
+  - ValidPlayer - The player who would discard must match this.
+  - ValidCard - The the card that would be discarded must match this.
+  - ValidSource - The card causing the discard must match this.
+  - DiscardFromEffect - If true, only discards caused by spells/effects
+    will be replaced. Cleanup/statebased discards will not.
+
+There are 2 Replaced-variables:
+
+  - Card - The card that would be discarded.
+  - Player - The player that would have discarded
+
+## Draw
+
+Draw events are checked when a player is about to draw a card. There is
+1 special parameter:
+
+  - ValidPlayer - The player who would draw must match this.
+
+There are no Replaced-variables.
+
+## GainLife
+
+GainLife events are checked when a player would gain life. There is 1
+special parameter:
+
+  - ValidPlayer - The player who would gain life must match this.
+
+There is 1 Replaced-variable:
+
+  - LifeGained - The amount of damage to be gained.
+
+## GameLoss
+
+GameLoss events are checked when a player would lose. There is 1 special
+parameter:
+
+  - ValidPlayer - The player who would lose must match this.
+
+There are no Replaced-variables.
+
+## Moved
+
+Moved events are checked when a card would be moved between zones. There
+are 3 special parameters:
+
+  - ValidCard - The moving card must match this.
+  - Origin - The card must be moving from this zone.
+  - Destination - The card must be moving to this zone.
+
+There is 1 Replaced-variable:
+
+  - Card - The moving card.

docs/Card-scripting-API/Restrictions.md

@@ -0,0 +1,103 @@
+### Activation
+
+Activation$ <Option> can accept several different values:
+
+  - Metalcraft
+  - Threshold
+  - Hellbent
+
+These basically follow the text of the card.
+
+### ActivationZone
+
+ActivationZone$ <Zone> For cards that have abilities that you can
+activate outside of the Battlefield
+
+### Flashback
+
+While Flashback isn't technically an SA\_Restriction it's listed here
+because it's handled very similarly in AFs. If sets the ActivationZone
+to Graveyard and sets the FlashbackAbility flag of a SpellAbility which
+will exile the card as it finishes resolving.
+
+### SorcerySpeed
+
+SorcerySpeed $True For cards that can only activate if you could cast a
+sorcery.
+
+### PlayerTurn
+
+PlayerTurn $True For cards that can only be activated during the
+activating player's turn.
+
+### OpponentTurn
+
+OpponentTurn $True For cards that can only be activated during the
+opponent's turn of the activating player.
+
+### AnyPlayer
+
+AnyPlayer $True For cards that can be activated by any player. Prophecy
+has lots of examples of these types of cards.
+
+### ActivationLimit
+
+ActivationLimit$<activationsPerTurn> For cards that have a limited
+amount of uses
+
+### ActivationNumberSacrifice
+
+ActivationNumberSacrifice$<activations> For cards that if they you
+activate them more than a certain amount per turn are sacrificed at end
+of the turn.
+
+### ActivationPhases
+
+ActivationPhases$\<Phases,Seperated,By,Commas\> For Abilities can only
+be activated during upkeep then it'll be ActivationPhases$Upkeep if it's
+before Declare Attackers than it's
+ActivationPhases$Upkeep,Draw,Main1,BeginCombat
+
+This can also be handled in a range. ActivationPhases$
+BeginCombat-\>EndCombat for Spells that can only be cast during combat.
+
+### ActivationCardsInHand
+
+ActivationCardsInHand$<CardsInHand> For Abilities with Hellbent (for 0)
+or Library of Alexandria (for 7)
+
+### Planeswalker
+
+Planeswalker$ True For Planeswalker Abilities. These can only be
+activated at Sorcery Speed, and only if no Planeswalker Abilities
+(including this ability) on this card have been activated that turn.
+
+Add Ultimate$ True when applicable for the AI and achievements.
+
+### Present
+
+Present is a Restriction that comes in two parts. IsPresent is required.
+And PresentCompare is optional.
+
+#### IsPresent
+
+IsPresent$ <ValidCards> gets all cards on the battlefield that is
+considered a ValidCard.
+
+#### PresentCompare
+
+PresentCompare$\<2 Letter Comparison\><Comparator>. The comparisons are
+LE,LT,EQ,NE,GE,GT and translated to \<=, \<, ==, \!=, \>=, \>. The
+comparator is on the right side of the equation.
+
+If PresentCompare is **missing**, the Restriction defaults to GE1.
+
+### Condition
+Condition is similar to a IsPresent restriction, except it's checked on Resolution of the spell and not on Activation.
+
+### CheckSVar
+
+CheckSVar specifies that the results computed from an SVar (Usually via
+xCount) must equal a certain value which you can specify in the
+accompanying SVarCompare parameter. SVarCompare is the same as
+PresentCompare above.

docs/Card-scripting-API/Targeting.md

@@ -0,0 +1,219 @@
+# Affected
+
+A defined parameter can be either for something that states what is
+receiving the action. Remember this is non-targeted!
+
+## Defined Players
+
+Defined Players are for SAs like Draw or Discard. They tell you who is
+receiving this action (but not in a targeted way).
+
+### You
+
+The most common of these is Defined$ You. It means exactly what you
+think "You draw a card." "You discard a card." Cards that don't seem to
+define anything that affect Players should default to "You"
+
+A spell that lets you draw a card is:
+
+SP$ Draw \| Defined$ You
+
+It is important to include this in SAs that have an unclear "Default"
+value such as Damage.
+
+### Opponent
+
+Also, fairly common is Defined$ Opponent. It means "Deals damage to each
+opponent" "Each Opponent discards a card."
+
+A spell that deals damage to each opponent is:
+
+SP$DealDamage \| Defined$ Opponent \| NumDmg$ 5
+
+### TargetedController
+
+### TargetedOwner
+
+### EnchantedController
+
+It means, "the controller of the enchanted thing." This would be the
+"that player" part of things like "At the beginning of enchanted
+creature's controller's upkeep, that player loses 1 life."
+
+### EnchantedOwner
+
+### AttackingPlayer
+
+Things like "Whenever Souls of the Faultless is dealt combat damage, you
+gain that much life and attacking player loses that much life."
+
+### DefendingPlayer
+
+Things like "Whenever CARDNAME deals combat damage, defending player
+discards a card."
+
+### Player
+
+Each player.
+
+## Defined Cards
+
+Defined Cards are for SAs like Pump or Regenerate. They tell you who is
+receiving this action (but not in a targeted way).
+
+### Self
+
+The most common of these is Defined$ Self. It means exactly what you
+think "I gain Flying" "Regenerate Me." Abilities that don't seem to
+define anything should affect Cards default to "Self"
+
+AB$Regenerate\| Defined$ Self
+
+It is important to include this in SAs that have an unclear "Default"
+value such as Damage.
+
+### Enchanted
+
+Enchanted is fairly common. It means "do this action to the card I'm
+Enchanted to"
+
+A simple example is a card that Pumps the attack of the Enchanted creature
+
+AB$Pump \| Defined$ Enchanted \| NumAtt$ +1
+
+### Equipped
+
+Equipped isn't very common, but is very similar. It means "do this
+action to the card I'm Equipped to"
+
+AB$Pump \| Defined$ Equipped \| NumAtt$ +2 \| NumDef$ +2
+
+### Remembered
+
+### ThisTurnEntered
+
+ThisTurnEntered lets you make the ability act on valid cards that were
+put in a certain zone,from a certain zone, this turn. The format is
+"ThisTurnEntered <Destination> \[from <Origin>\] <ValidExpression>".
+
+For example: No Rest for the Wicked and the like would use:
+`AB$ ChangeZone | Cost$ Sac<1/CARDNAME> | Defined$ ThisTurnEntered Graveyard from Battlefield Creature.YouCtrl | SpellDescription$ Return to your hand all creature cards in your graveyard that were put there from the battlefield this turn.`
+
+### Targeted
+
+Targeted will only appear on a [SubAbility][]. It means "Do this action
+to whatever a parent Ability targeted"
+
+That may sound confusing so here's an example.
+
+If you had a spell that says "Untap target Creature. It gains +1/+1
+until end of turn" it would look like similar to this.
+
+SP$Untap \| ValidTgts$ Creature \| SubAbility$ DBPump
+
+SVar:DBPump:DB$Pump \| Defined$ Targeted \| NumAtt$ +1 \| NumDef$ +1
+
+# Targets
+
+Each element follows the form:
+
+CardType{.restriction}{+furtherRestriction}
+
+The restrictions are optional.
+
+CardType may be any type, generally the supertypes like Creature,
+Artifact, Enchantment, Land, etc. However, it could also be Elf or
+Goblin... though that would also include Elf Enchantments, for example.
+To specify an Elf Creature, then it should be "Creature.Elf".
+"Permanent" represents any permanent, "Card" any card....
+
+Restrictions other than type that are interpreted: (case sensitive)
+
+`   named{Name}`  
+`   notNamed{Name}`  
+`   sameName`  
+`   NamedCard`
+
+`   Color, nonColor (White, nonWhite, etc)`  
+`   Colorless, nonColorless`  
+`   Multicolor, nonMulticolor`  
+`   MonoColor, nonMonoColor`  
+`   ChosenColor`  
+`   SharesColorWith`
+
+`   YouCtrl, YouDontCtrl`  
+`   YouOwn, YouDontOwn`  
+`   EnchantedPlayerCtrl`  
+`   OwnerDoesntControl`  
+`   ControllerControls{type}`  
+`   RememberedPlayerCtrl (use if Remember will be set before resolution)`  
+`   TargetedPlayerCtrl (only use if restriction is needed wile initial targeting happens)`
+
+`   Other,Self`
+
+`   AttachedBy,Attached`  
+`   DamagedBy,Damaged`
+
+`   with{Keyword}, without{Keyword}`  
+`   tapped, untapped`  
+`   faceDown`  
+`   enchanted, unenchanted, enchanting, EnchantedBy`  
+`   equipped, unequipped, equipping, EquippedBy`  
+`   dealtDamageToYouThisTurn`  
+`   wasDealtDamageThisTurn`  
+`   wasDealtDamageByHostThisTurn`  
+`   wasDealtDamageByEquipeeThisTurn`  
+`   token, nonToken`  
+`   kicked, notkicked`  
+`   enteredBattlefieldThisTurn`
+
+`   power{cmp}{X or #}`  
+`   toughness{cmp}{X or #}`  
+`   cmc{cmp}{X or #}`  
+`   {cmp} is a comparator:`  
+`       LT - Less Than`  
+`       LE - Less than or Equal`  
+`       EQ - EQual`  
+`       GE - Greater than or Equal`  
+`       GT - Greater Than`  
+`   X is parsed from "SVar:X:Count$___"`
+
+`   greatestPower, leastPower`  
+`   greatestCMC`
+
+`   counters{cmp}{X or #}{Type}`
+
+`   attacking, notattacking`  
+`   blocking, notblocking`  
+`   blocked, unblocked, blockedBySource`  
+`   kicked, notkicked`  
+`   evoked`  
+`   hasDevoured, hasNotDevoured`  
+`   non{Type}`  
+`   ChosenType{Type} `  
+`   {Type}`
+
+`   CostsPhyrexianMana`
+
+`   Above, DirectlyAbove`  
+`   TopGraveyardCreature`  
+`   TopGraveyard`
+
+`   Cloned`
+
+`   isRemembered`
+
+Examples:
+
+"Artifact or Enchantment" would be represented as 2 elements "Artifact,Enchantment"
+
+"non-black, non-artifact creature" would be represented as  "Creature.nonBlack+nonArtifact"
+
+"creature with power 2 or less" would be "Creature.powerLE2"
+
+"nonbasic land" is "Land.nonBasic"
+
+"creature with flying" is "Creature.withFlying"
+
+"creature self with four or more level counters" is
+"Creature.countersGE4LEVEL+Self"

docs/Card-scripting-API/Triggers.md

@@ -0,0 +1,918 @@
+Triggers define when an ability should be automatically added to the
+stack. Their syntax in the card files are very similar to that used by
+the various AbilityFactorys, that is: every trigger line starts with
+"T:" (without the quotes) and is a collection of name-value pairs (name
+and value are separated by $) separated by pipes (|). Like with
+AbilityFactorys, there are a few that show up almost always if not
+always. There are two parameters that are always present on a trigger:
+
+  - Mode - Specifies what kind of situation the trigger should wait for.
+  - TriggerDescription - Describes the trigger, much like AF's
+    SpellDescription parameter.
+  - (Execute - Specifies the name of the SVar that holds the ability to
+    run when the trigger goes off.)
+
+_NOTE: The Execute parameter may be absent, if you are writing a delayed triggered ability. See below._
+
+Depending on which Mode is specified, other parameters may be expected.
+Below are the currently available modes.
+
+The script has access to many things that were previously internal to
+triggers. These things are accessed via Triggered-variables. Triggered
+variables are always of the form "Triggered<Variable Name>\[Controller/Owner\]" and are specific to each trigger mode. You can use Triggered-variables that return a card or a player directly in Defined$ parameters or to grab extra info from (like you use "Targeted" for, for instance "SVar:X:TriggeredCard$CardPower").
+You can get the controller or owner of a card returned by a Triggered-variable by appending "Controller" or "Owner" to the variable. Triggered-variables that return an integer can only be accessed from Count$, i.e. "SVar:X:Count$TriggeredLifeAmount".
+
+Other parameters that triggers can use are:
+
+  - Secondary - If a trigger has Secondary$ True set, it means that it's
+    trigger description won't show up in a card's text box. This can be
+    used if you need to use several triggers to emulate a single effect
+    on a real card.
+  - Static - This parameter is mainly used for "As CARDNAME enters the
+    battlefield..." type things. It causes the triggered ability to
+    resolve right away, instead of going on the stack.
+  - ResolvingCheck
+  - NoResolvingCheck - makes a trigger not recheck its condition to resolve
+
+## Always
+
+Always-triggers represent State triggers, a special kind of triggers. These triggers will not do any checks for intervening if-clauses and will not go on the stack if an instance of it has already been put there. They are checked every time state effects are checked.  
+Examples: Emperor Crocodile.  
+There are no special parameters and no triggered-variables.
+
+## Attached
+
+Attached-triggers go off when a card is attached, via enchanting or
+equipping, to another card.  
+Examples: Bramble Elemental, Kithkin Armor.  
+There are 2 special parameters:
+
+  - ValidSource - The card that is being attached to another must match
+    this for the trigger to go off.
+  - ValidTarget - The card that is having another card attached to it
+    must match this.
+
+There are 2 Triggered-variables:
+
+  - Source - The card that is being attached.
+  - Target - The card that is being attached to.
+
+## AttackerBlocked
+
+AttackerBlocked-triggers go off when a creature becomes blocked. It goes
+off only once (no matter how many blockers there are) right after the
+declare blockers step.  
+Examples: AEther Membrane, Alley Grifters.  
+There are 2 special parameters:
+
+  - ValidCard - The attacking creature must match this for the trigger
+    to go off.
+  - ValidBlocker - The blocking creature must match this for the trigger
+    to go off.
+
+There are 3 Triggered-variables:
+
+  - Attacker - The card of the attacking creature.
+  - Blocker - The card of the blocking creaure.
+  - NumBlockers - The number of things blocking the attacker
+
+## AttackerUnblocked
+
+AttackerUnblocked-triggers go off when a creature attacks and is not
+blocked, right after the declare blockers step.  
+Examples: Abyssal Nightstalker, Dauthi Mindripper  
+There is 1 special parameter:
+
+  - ValidCard - The attacking creature must match this for the trigger
+    to go off.
+
+There is 1 Triggered-variable:
+
+  - Attacker - The card of the attacking creature.
+
+## AttackersDeclared
+
+Goes off after attackers are declared, if any attackers were declared,
+once a combat only.  
+Examples: Lightmine Field, Curse of Inertia. There are 2 special
+parameters:
+
+  - AttackingPlayer - The attacking player must match this.
+  - AttackedTarget - One of the game entities in TriggeredAttackedTarget
+    must match this.
+
+There are 3 Triggered-variables:
+
+  - Attackers - Collection of attacking creatures.
+  - AttackingPlayer - The targeted object.
+  - AttackedTarget - Collection of game entities that each attacker is attacking.
+
+## Attacks
+
+Attacks-triggers go off when a creature attacks. That is, it goes off
+once for each creature that attacks during your each combat phase (Right
+after the declare attackers step).  
+Examples: Accorder Paladin, Trepanation Blade.  
+There are 2 special parameters:
+
+  - ValidCard - The attacking creature must match this for the trigger
+    to go off.
+  - Alone - If this is True, the trigger will only go off if the
+    creature attacks alone.
+
+There is 1 Triggered-variable:
+
+  - Attacker - The card of the attacking creature.
+
+## BecomeMonstrous
+
+BecomeMonstrous-triggers go off when a creature becomes Monstrous,
+naturally.  
+Examples: Arbor Colossus, Ember Swallower.  
+There is 1 special parameter:
+
+  - ValidCard - The card that becomes monstrous must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that became monstrous.
+
+## BecomesTarget
+
+BecomesTarget-triggers go off when a spell or ability (or either) is put
+on the stack targeting something that matches a Valid-expression.  
+Examples: Angelic Protector, Cephalid Illusionist.  
+There are 3 special parameters:
+
+  - SourceType - Can be Spell or Ability.It is optional.
+  - ValidSource - The card that targets something must match this.
+  - ValidTarget - The targeted object must match this.
+
+There are 2 Triggered-variables:
+
+  - Source - The targeting card.
+  - Target - The targeted object.
+
+## BlockersDeclared
+
+Goes off after blockers are declared if there are any, once in a combat
+only. (unlike Blocks, which goes off once for each creature that blocks.)  
+Examples: Tide of War  
+There are no special parameters.  
+There are 2 Triggered-variables:
+
+  - Blockers - Collection of all blockers.
+  - Attackers - Collection of all attackers.
+
+## Blocks
+
+Blocks-triggers go off when a creature blocks (No surprise there ;) ).  
+Examples: Amphibious Kavu, Cinder Wall (See below).  
+There are 2 special parameters:
+
+  - ValidCard - The blocking creature must match this.
+  - ValidBlocked - The creature being blocked must match this.
+
+There are 2 Triggered-variables:
+
+  - Attacker - The card of the attacking creature.
+  - Blocker - The card of the blocking creaure.
+
+## Championed
+
+Goes off when a creature is championed.  
+Examples: Mistbind Clique.  
+There are 2 special parameters:
+
+  - ValidCard - The card being exiled for championing must match this.
+  - ValidSource - The champion card that is being played must match
+    this.
+
+There are 2 Triggered-variables:
+
+  - Championed - The champion-exiled card
+  - Card - The championing card.
+
+## ChangesController
+
+Goes off when a card changes controller.  
+Examples: Coffin Queen, Duplicity.  
+There are 2 special parameters:
+
+  - ValidCard - The card whose controller changes must match this.
+  - ValidOriginalController - The player who originally controlled the
+    card must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card whose controller changes.
+
+## ChangesZone
+
+ChangesZone-triggers go off whenever, you guessed it, a card changes
+zone.  
+Examples: Contagion Clasp, see below.  
+There are 3 special parameters:
+
+  - ValidCard - The card that was moved must match this for the trigger
+    to go off.
+  - Origin - The card must be moved from this zone for the trigger to go
+    off. (Defaults to "Any")
+  - Destination - The card must be moved to this zone for the trigger to
+    go off. (Defaults to "Any")
+
+There is 1 Triggered-variable:
+
+  - Card - The card that was moved.
+
+## Clashed
+
+Clashed-triggers go off whenever a player has clashed, regardless of
+wether you won or not. They are always run after the clash is through.  
+Examples: Entangling Trap, Rebellion of the Flamekin.  
+There are 2 special parameters:
+
+  - ValidPlayer - Who clashed.
+  - Won - True if the player must have won, false otherwise.
+
+There are no Triggered-variables.
+
+## CombatDamageDoneOnce
+
+Goes off once for every game entity that recieves damage in combat.  
+Examples: Nature's Will, Pyrewild Shaman.  
+There are 2 special parameters:
+
+  - ValidSource - One or more of the game entities that dealt the damage
+    must match this.
+  - ValidTarget - The game entity that recieved damage must match this.
+
+There are 2 Triggered-variables:
+
+  - Sources - A collection of the game entities that dealt the damage.
+  - Target - The game entity that recieved damage.
+
+## CounterAdded & CounterRemoved
+
+These triggers go off when a counter is added to / removed from a
+card.  
+Examples: Bloodcrazed Hoplite, Aeon Chronicler.  
+There are 2 or 3 special parameters:
+
+  - ValidCard - The card getting the counter must match this for the
+    trigger to go off.
+  - CounterType - The counter must be of this type for the trigger to go
+    off.
+  - NewCounterAmount - The counter amount AFTER the trigger fires must
+    be this. NOTE: only available to CounterRemoved at the moment.
+
+There is 1 Triggered-variable:
+
+  - Card - the card the counter was added to
+
+## Countered
+
+Goes off when a spell or ability is countered.  
+Examples: Lullmage Mentor, Multani's Presence.  
+There are 3 special parameters:
+
+  - ValidCard - The host card of the spell/ability that was countered
+    must match this.
+  - ValidPlayer - The player that cast/activated the spell/ability that
+    was countered must match this.
+  - ValidCause - The host card of the spell/ability that did the
+    countering must match this.
+
+There are 3 Triggered-variables:
+
+  - Card - The host card of the spell/ability that was countered.
+  - Player - The player that cast/activated the spell/ability that was
+    countered.
+  - Cause - The host card of the spell/ability that did the countering.
+
+## Cycled
+
+Cycled-triggers simply go off whenever you cycle a card.  
+Examples: Astral Slide, Bant Sojourners.  
+There is 1 special parameters:
+
+  - ValidCard - The card that was cycled must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that was cycled.
+
+## DamageDone
+
+DamageDone-triggers go off whenever any source deals damage to any
+target.  
+Examples: Abomination of Gudul, Prophetic Flamespeaker.  
+There are 4 special parameters:
+
+  - ValidSource - The source of the damage must match this.
+  - ValidTarget - The target of the damage must match this.
+  - CombatDamage - If set to true, the trigger will only go off if the
+    damage dealt was combat damage.If set to false, it will only go off
+    if it wasn't combat damage.. If omitted, it will go off either way.
+  - DamageAmount - Specifies how much damage must be done for the
+    trigger to go off. It takes the form "<operator><operand>" where
+    <operator> can be LT (Less Than),LE (Less than or Equal),EQ
+    (Equal),GE (Greater than or Equal) or GT (Greater Than) and
+    <operand> is a positive integer.
+
+There are 3 Triggered-variables:
+
+  - Source - The source of the damage.
+  - Target - The target of the damage.
+  - DamageAmount - The amount of damage dealt(integer).
+
+<b>BEWARE: Since the Target variable can be either a player or a card,
+you must take care to limit this in the ValidTarget parameter\!</b>
+
+## DealtCombatDamageOnce
+
+Goes off \*once\* for each creature that deals damage in combat.  
+Examples: Arashin War Beast, Five Alarm Fire.  
+There are 2 special parameters:
+
+  - ValidTarget - The game entity that recieves damage must match this.
+  - ValidSource - The card that dealt damage must match this.
+
+There are 2 Triggered-variables:
+
+  - Target - The game entity that recieves damage.
+  - Source - The card that dealt damage.
+
+## Destroyed
+
+Goes off when a permanent is destroyed. (Not if it it destroyed, but
+then regenerated.)  
+Examples: Cobra Trap, Sacred Ground.  
+There are 2 special parameters:
+
+  - ValidCard - The card that was destroyed must match this.
+  - ValidCauser - The player that activated the spell/ability that
+    destroyed the card must match this.
+
+There are 2 Triggered-variables:
+
+  - Card - The card that was destroyed.
+  - Causer - The player that activated the spell/ability that destroyed
+    the card.
+
+## Devoured
+
+Goes off when a creature is sacrificed for a Devour creature.  
+Examples: Kresh the Bloodbraided Avatar.  
+There is 1 special parameter:
+
+  - ValidDevoured - The devoured creature must match this.
+
+There is 1 Triggered-variable:
+
+  - Devoured - The devoured creature.
+
+## Discarded
+
+Discarded-triggers go off whenever a card is discarded from a players
+hand. (side note: ChangesZone-triggers may also go off here because the
+card is moved from the hand to the graveyard)  
+Examples: Abyssal Nocturnus, Confessor.  
+There are 3 special parameters:
+
+  - ValidPlayer - The player who discarded the card must match this.
+  - ValidCard - The discarded card must match this.
+  - ValidCause - The card that caused the player to discard must match
+    this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that was discarded.
+
+## Drawn
+
+Drawn-triggers go off when a player draws a card.  
+Examples: Booby Trap, Kederekt Parasite.  
+There is 1 special parameter:
+
+  - ValidCard - The drawn card must match this.
+
+There are 2 Triggered-variable:
+
+  - Card - The card that was drawn.
+  - Player - The player that drew the card.
+
+## Evolved
+
+Goes off when a creature gets a +1/+1 counter from evolving.  
+Examples: Renegade Krasis.  
+There is 1 special parameter:
+
+  - ValidCard - The card that got the counter must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that got the counter.
+
+## FlippedCoin
+
+Goes off when a player flips a coin.  
+Examples: Chance Encounter, Karplusan Minotaur.  
+There are 2 special parameter:
+
+  - ValidPlayer - The player who flipped the coin must match this.
+  - ValidResult - If this parameter is "Win", the player must win the
+    flip.
+
+There is 1 Triggered-variable:
+
+  - Player - The player who flipped the coin.
+
+## LandPlayed
+
+LandPlayed-triggers of course go off when a land is played.  
+Examples: Burgeoning, City of Traitors.  
+There is 1 special parameter:
+
+  - ValidCard - The played card must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that was played.
+
+## LifeGained & LifeLost
+
+These triggers go off on when a player either gains or loses life, of
+course.  
+Examples: Cradle of Vitality, Exquisite Blood.  
+There is 1 special parameter:
+
+  - ValidPlayer - The player who gained or lost life must match this.
+
+There are 2 Triggered-variables:
+
+  - Player - The player that gained/lost life.
+  - LifeAmount - The amount of life lost/gained. (integer)
+
+## LosesGame
+
+Goes off when a player loses the game.  
+Examples: Blood Tyrant, Elbrus, the Binding Blade // Withengar Unbound  
+There is 1 special parameter:
+
+  - ValidPlayer - The player who lost the game must match this.
+
+There is 1 Triggered-variable:
+
+  - Player - The Player who lost the game.
+
+## NewGame
+
+Goes off once at the start of each game, after mulligans.  
+Examples: Maralen of the Mornsong Avatar, Worldknit.  
+There are no special parameters or Triggered-variables.
+
+## PayCumulativeUpkeep
+
+Goes off when a player pays or doesn't pay the cumulative upkeep for a
+card.  
+Examples: Balduvian Fallen, Heart of Bogardan.  
+There are 2 special parameters:
+
+  - Paid - Wether or not the player must have paid the cumulative
+    upkeep.
+  - ValidCard - The card that has the cumulative upkeep must match this.
+
+There are 2 Triggered-variables:
+
+  - Card - The card that has the cumulative upkeep.
+  - PayingMana - A string representing the mana spent.
+
+## PayEcho
+
+Goes off when a player pays or doesn't pay the echo cost for a card.  
+Examples: Shah of Naar Isle.  
+There are 2 special parameters:
+
+  - Paid - Wether or not the player must have paid the echo.
+  - ValidCard - The card that has the echo must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that has the echo.
+
+## Phase
+
+Phase-triggers go off at specific points in the turns.  
+Examples: AEther Vial, see below.  
+There are 2 special parameters:
+
+  - Phase - The phase during which the trigger should go off.
+  - ValidPlayer - The player who's turn it should be.
+
+There is 1 Triggered-variable:
+
+  - Player - The player whose turn it is.
+
+## PhaseIn & PhaseOut
+
+Goes off when a permanent phases in or out, specifically only while that
+permanent is still on the battlefield since triggers don't work on
+phased out objects.  
+Examples: Shimmering Efreet, Ertai's Familiar.  
+There is 1 special parameter:
+
+  - ValidCard - The card phasing in or out must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card phasing in or out.
+
+## PlanarDice
+
+Goes off when the planar dice is rolled in a Planechase game.  
+Examples: Panopticon, Orzhova.  
+There are 2 special parameters:
+
+  - ValidPlayer - The player that rolled the dice must match this.
+  - Result - The dice must roll this. Blank,Chaos or Planeswalk.
+
+There is 1 Triggered-variable:
+
+  - Player - The player that rolled the dice.
+
+## PlaneswalkedTo & PlaneswalkedFrom
+
+These triggers go off when a player planeswalks to or away from one or
+more planes.  
+Examples: Panopticon, Orzhova.  
+There is 1 special parameter:
+
+  - ValidCard - One of the planes must match this.
+
+There is 1 Triggered-variable:
+
+  - Cards - A collection of all the cards planeswalked to or from.
+
+## Sacrificed
+
+Sacrificed-triggers go off whenever a player sacrifices a permanent.  
+Examples: Dragon Appeasement, Mortician Beetle.  
+There are 2 special parameters:
+
+  - ValidPlayer - The player who sacrificed the card must match this.
+  - ValidCard - The sacrificed card must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that was Sacrificed.
+
+## Scry
+
+Goes off after a player has scryed and put the card(s) in the proper
+place.  
+Examples: Flamespeaker Adept, Knowledge and Power  
+There is 1 special parameter:
+
+  - ValidPlayer - The player that scryed must match this.
+
+There is 1 Triggered-variable:
+
+  - Player - The player that scryed.
+
+## SearchedLibrary
+
+Goes off when a player searches a library.  
+Examples: Ob Nixilis, Unshackled.  
+There are 2 special parameters:
+
+  - ValidPlayer - The player searching must match this.
+  - SearchOwnLibrary - If true, the player must be searching his or her
+    own library (Didn't see that one coming, did ya? :P)
+
+There is 1 Triggered-variable:
+
+  - Player - The player searching.
+
+## SetInMotion
+
+Goes off when an Archenemy Scheme is set in motion.  
+Examples: A Display of My Dark Power, Perhaps You've Met My Cohort.  
+There is 1 special parameter:
+
+  - ValidCard - The scheme card that is set in motion must match this.
+
+There is 1 Triggered-variable:
+
+  - Scheme - The scheme card that is set in motion.
+
+## Shuffled
+
+Shuffled-triggers go off whenever a player shuffles his/her library.  
+Examples: Cosi's Trickster, Psychic Surgery.  
+There is 1 special parameter:
+
+  - ValidPlayer - The player who's turn it should be.
+
+There is 1 Triggered-variable:
+
+  - Player - The player whose turn it is.
+
+## SpellCast, AbilityCast & SpellAbilityCast
+
+Triggers go off whenever a spell,ability or either respectively is cast
+by either player.  
+Examples: AEther Barrier, Burning-Tree Shaman, Grip of Chaos.  
+There are 4 special parameters:
+
+  - ValidControllingPlayer - The player who controls the cast spell must
+    match this.
+  - ValidActivatingPlayer - The player who activated the ability/spell
+    must match this. (NOTE: For spells, the activator and controller are
+    the same. They usually the same for abilities too, with the
+    exception being abilities that can be activated by any player)
+  - ValidCard - The card the cast spell or ability originates from must
+    match this.
+  - TargetsValid - If this parameter is present, the spell or ability
+    must be targeted and at least one of it's targets must match this.
+
+There are 4 Triggered-variable:
+
+  - Card - The card that the cast spell or ability originates from.
+  - SpellAbility - The SpellAbility object.
+  - Player - The player that controls the card that the cast spell or
+    ability originates from.
+  - Activator - The player that activated the ability.
+
+## Taps & Untaps
+
+These triggers go off when a permanent taps or untaps.  
+Examples: Artifact Possession, Frightshroud Courier.  
+There is 1 special parameter:
+
+  - ValidCard - The card that taps or untaps must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that was tapped/untapped.
+
+## TapsForMana
+
+This trigger goes off when a land is tapped for a mana ability.  
+Examples: Bubbling Muck, Market Festival.  
+There is 1 special parameter:
+
+  - ValidCard - The card that taps.
+
+There are 3 Triggered-variable:
+
+  - Card - The card that was tapped.
+  - Player - the payer that did the tapping
+  - Produced - a String of the Mana produced by this tapping.
+
+## Transformed
+
+Goes off when a card changes state from Original to Transformed or vice
+versa. (But not between any other 2 states)  
+Examples: Afflicted Deserter // Werewolf Ransacker, Huntmaster of the
+Fells // Ravager of the Fells.  
+There is 1 special parameter:
+
+  - ValidCard - The card that changes state must match this.
+
+There is 1 Triggered-variable:
+
+  - Transformer - The card that changes state.
+
+## TurnFaceUp
+
+Goes off when a card changes state from FaceDown to Original. (But not
+between any other 2 states)  
+Examples: Aphetto Exterminator, Fatal Mutation.  
+There is 1 special parameter:
+
+  - ValidCard - The card that changes state must match this.
+
+There is 1 Triggered-variable:
+
+  - Card - The card that changes state.
+
+## Unequip
+
+Goes off when an equipment card is unattached from a creature, wether
+it's voluntarily unattached or not.  
+Examples: Grafted Exoskeleton, Grafted Wargear.  
+There are 2 special parameters:
+
+  - ValidCard - The card that the equipment is unattached from must
+    match this.
+  - ValidEquipment - The equipment being unattached must match this.
+
+There are 2 Triggered-variables:
+
+  - Card - The card that the equipment is unattached from.
+  - Equipment - The equipment being unattached.
+
+## Vote
+
+Goes off when a vote is called for, after all votes are cast.  
+Examples: Grudge Keeper.  
+There are no special parameters.  
+There is 1 Triggered-variable:
+
+  - OtherVoters - A collection of every player who voted, EXCEPT the
+    controller of the trigger's host card.
+
+# Restrictions
+
+You can use certain optional parameters to further restrict when a
+trigger should go off. These parameters are:
+
+  - TriggerZones - This parameter can be used to restrict which zone the
+    card must be in in order for the trigger to go off. For example, if
+    the trigger should only go off while the card is in the graveyard
+    (As in Auntie's Snitch or Bridge from Below) you can use
+    `TriggerZones$ Graveyard`
+  - TriggerPhases - This parameter can be used to restrict the phases in
+    which the trigger can trigger.
+  - OpponentTurn - This parameter can be used to restrict the trigger to
+    only trigger on your opponents turn.(True/False)
+  - PlayerTurn - This parameter can be used to restrict the trigger to
+    only trigger on your turn.(True/False)
+  - Metalcraft - If this parameter is set to "True", the controller of
+    this card must have 3 or more artifacts on the battlefield for the
+    trigger to go off.
+  - Threshold - As Metalcraft but requires the controller of the card to
+    have 7 cards in the graveyard.
+  - PlayersPoisoned - This parameter specifies that a certain or both
+    players must have at least 1 poison counter. Valid values are "You",
+    "Opponent" or "Each".
+  - IsPresent - This parameter expects a
+    [ValidCard](Forge_ValidCards "wikilink") formula and only lets the
+    trigger go off if there is a permanent on the battlefield that
+    matches it.
+  - PresentCompare,PresentZone & PresentPlayer - These parameters only
+    matter if the IsPresent parameter is used. They can be used to
+    narrow down and how many valid cards must be present and where they
+    must be.
+  - IsPresent2,PresentCompare2,PresentZone2 & PresentPlayer2 - Second
+    requirement (see above).
+  - CheckSVar - Calculates the named SVar and compares the result
+    against the accompanying SVarCompare parameter which takes the form
+    of <operator><operand> where <operator> is in LT,LE,EQ,NE,GE,GT.
+
+# Examples
+
+Learn by example\!
+
+## Contagion Clasp
+
+(When Contagion Clasp enters the battlefield, put a -1/-1 counter on
+target creature.) The first thing to do is to identify the WHEN, i.e.
+when the trigger should go off so that we can decide on the proper mode.
+Here it should go off when a particular card moves from one zone into
+another, so ChangesZone is the logical mode here.  
+`T:Mode$ ChangesZone`  
+Next we look at which of ChangesZone's 3 special parameters we want to
+make use of. Well, we want the trigger to go off when the card enters
+one specific zone, so we'll want to use the Destination parameter. Also,
+we only care about when it's a specific card being moved so we'll use
+ValidCard.  
+`T:Mode$ ChangesZone | Destination$ Battlefield | ValidCard$
+Card.Self`  
+There, we've defined a trigger that goes off when this card moves from
+any zone (remember, Origin and Destination defaults to "Any") to the
+battlefield zone. But we still have to use two more parameters. First,
+"Execute". Execute should contain the name of the SVar that holds the
+Ability you want to be triggered.It can be any valid SVar name. I like
+to follow the convention "Trig<name of the abilityfactory used>" but
+your mileage may vary.  
+`T:Mode$ ChangesZone | Destination$ Battlefield | ValidCard$ Card.Self |
+Execute$ TrigPutCounter`  
+Lastly, "TriggerDescription". This is what will be put in the cards text
+box, i.e. the rules text. Always try to keep it as close to Oracle
+wording as possible. Also, you should use "CARDNAME" instead of the name
+of the card for convention.  
+`T:Mode$ ChangesZone | Destination$ Battlefield | ValidCard$ Card.Self |
+Execute$ TrigPutCounter | TriggerDescription$ When CARDNAME enters the
+battlefield, put a -1/-1 counter on target creature.`  
+So we're all done,then?No, it's not a triggered <b>ability</b> until it
+actually has an ability. To define the ability we want to be triggered
+we simply use an [AbilityFactory](Forge_AbilityFactory "wikilink") but
+instead of putting it on it's own line beginning with "A:", we put it in
+an SVar named what we put for the Execute parameter.  
+`T:Mode$ ChangesZone | Destination$ Battlefield | ValidCard$ Card.Self |
+Execute$ TrigPutCounter | TriggerDescription$ When CARDNAME enters the
+battlefield, put a -1/-1 counter on target creature.`  
+`SVar:TrigPutCounter:AB$PutCounter | Cost$ 0 | Tgt$ TgtC | CounterType$
+M1M1 | CounterNum$ 1`  
+You may notice some strange things about the ability, namely the Cost
+parameter and the lack of a SpellDescription parameter.The reasoning for
+these things is that AbilityFactory requires non-drawback abilities to
+have a cost and drawback abilities not to have one. But if you want to
+do something like "When CARDNAME comes into play, you may pay 1 to...",
+that's where you'd use the Cost parameter here. The SpellDescription is
+missing because triggers use their own TriggerDescription instead.
+
+## AEther Vial
+
+(At the beginning of your upkeep, you may put a charge counter on AEther
+Vial.) Okay let's apply the procedure we learned when doing Contagion
+Clasp:  
+Identify the WHEN - It should go off at the beginning of a specific
+PHASE so, well, Phase mode it is\!  
+`T:Mode$ Phase`  
+Next,look at Phase modes special parameters: Phase and ValidPlayer. We
+can tell right away that Phase should be "Upkeep" and ValidPlayer should
+be "You" since it should only trigger on your turn.  
+`T:Mode$ Phase | Phase$ Upkeep | ValidPlayer$ You`  
+Next up, we have to make sure that the trigger only goes off when AEther
+Vial is in play. If it's not, why would we want to put counters on it?
+We can use the TriggerZones parameter to restrict where the card must be
+in order for the trigger to go off. It takes a comma-separated list of
+zones but since we only want AEther Vial to trigger when it's on the
+battlefield, we just give it "Battlefield".  
+`T:Mode$ Phase | Phase$ Upkeep | ValidPlayer$ You | TriggerZones$
+Battlefield`  
+Now then, there's one word in the rules text that changes things: "may".
+To give the player a choice about wether or not to make use of the
+triggered ability, we can use the OptionalDecider parameter. It's used
+the same way as Defined parameters for AFs and the player it evaluates
+to gets to decide if the trigger happens.  
+`T:Mode$ Phase | Phase$ Upkeep | ValidPlayer$ You | TriggerZones$
+Battlefield | OptionalDecider$ You`  
+Lastly as before, we add the Execute and TriggerDescription
+parameters...  
+`T:Mode$ Phase | Phase$ Upkeep | ValidPlayer$ You | TriggerZones$
+Battlefield | OptionalDecider$ You | Execute$ TrigPutCounter |
+TriggerDescription$ At the beginning of your upkeep, you may put a
+charge counter on CARDNAME.`  
+...And our mad AbilityFactory-skills to write up the actual ability\!  
+`T:Mode$ Phase | Phase$ Upkeep | ValidPlayer$ You | TriggerZones$
+Battlefield | OptionalDecider$ You | Execute$ TrigPutCounter |
+TriggerDescription$ At the beginning of your upkeep, you may put a
+charge counter on CARDNAME.`  
+`SVar:TrigPutCounter:AB$PutCounter | Cost$ 0 | Defined$ Self |
+CounterType$ CHARGE | CounterNum$ 1`  
+DING\! Goblins are up\!
+
+## Cinder Wall
+
+(When Cinder Wall blocks, destroy it at end of combat.) This will be an
+example of a delayed trigger. A delayed trigger goes on the stack twice,
+once when the conditions are met, and once when the effect should
+happen.In Cinder Wall's case, once when it blocks, and once at the
+following end of combat step. To start with, we create a Blocks trigger
+that looks this.  
+`T:Mode$ Blocks | ValidCard$ Card.Self`  
+And this is where delayed triggers differ from ordinary triggers.We do
+NOT add an Execute parameter that points to an SVar containing the
+trigger's effect as an AF. Instead we add a DelayedTrigger parameter
+that points to an SVar containing ANOTHER trigger that specifies when
+the delayed effect should occur. This delayed trigger is built like an
+ordinary trigger and further points to an ability (Using the Execute
+parameter).Don't forget to omit the "T:" from the delayed trigger, for
+the same reason you omit "A:" from abilities in SVars\!  
+`T:Mode$ Blocks | ValidCard$ Card.Self DelayedTrigger$ DelTrig |
+TriggerDescription$ When CARDNAME blocks, destroy it at end of
+combat.`  
+`SVar:DelTrig:Mode$ Phase | Phase$ EndCombat | Execute$ TrigDestroy |
+TriggerDescription$ Destroy CARDNAME.` `SVar:TrigDestroy:AB$Destroy |
+Cost$ 0 | Defined$ Self`  
+
+# Test Cards
+
+If you want some test cards for each trigger try these:
+
+    Always (Covetous Dragon)
+    DeclareAttack (Lightmine Field)
+    Attacks (Battle Cry)
+    Unblocked (Abyssal Nightstalker)
+    Blocked (Flanking)
+    Blocks (Wall of Junk)
+    Targeted (Tar Pit Warrior)
+    ChangeZones (Wall of Blossoms, AEther Flash, Valakut)
+    Phase (Bottomless Pit)
+    SpellAbilityCast (Dragonlair Spider)
+    Unqeuip (Grafted Wargear)
+    Sacrifice (Grave Pact)
+    Taps (Stonybrook Schoolmaster)
+    Untaps (Hollowsage)
+    Championed (Mistbind Clique/delayed due to input  issue)
+    ChangeControllers (?)
+    CounterAdded (Flourishing Defenses)
+    CounterRemoved (Fungal Behemoth)
+    Clashed (Sylvan Echoes)
+    Cycled (Bant Sojourners)
+    Damaged (Akki Underminer, Living Artifact)
+    Discarded (Megrim)
+    Drawn (Underworld Dreams)  
+    LandPlayed (Horn of Greed)
+    LifeGained (Ajani's Pridemate)
+    LifeLost (Mindcrank)
+    LoseGame
+    SetInMotion
+    Shuffled (Cosi's Trickster)
+    TapsForMana (Mana Flare)
+    Transformed (Afflicted Deserter)
+    TurnFaceUp (Bloodstoke Howler)

docs/Configure-Planes.md

@@ -0,0 +1,90 @@
+Base settings of a plane is configured in
+config.json
+
+Example:
+
+```json
+{
+  "screenWidth": 480,
+  "screenHeight": 270,
+  "skin": "skin/ui_skin.json",
+  "playerBaseSpeed": 32,
+  "minDeckSize": 40,
+  "starterDecks": [
+    "decks/starter/white.json",
+    "decks/starter/black.json",
+    "decks/starter/blue.json",
+    "decks/starter/red.json",
+    "decks/starter/green.json"
+  ],
+  "restrictedCards": [
+    "Black Lotus",  
+    "Ancestral Recall"
+  ],
+  "restrictedEditions": [],
+  "legalCards":{ 
+      "editions": ["M22","M21"] 
+    },
+  "difficulties": [
+    {
+      "name": "Easy",
+      "startingLife": 16,
+      "staringMoney": 500,
+      "enemyLifeFactor": 0.8,
+      "spawnRank": 0,
+      "sellFactor": 0.6,
+      "startItems": [
+        "Manasight Amulet",
+        "Leather Boots"
+      ]
+    },{
+      "name": "Normal",
+      "startingLife": 12,
+      "staringMoney": 250,
+      "startingDifficulty": true,
+      "enemyLifeFactor": 1.0,
+      "spawnRank": 1,
+      "sellFactor": 0.5,
+      "startItems": [
+        "Leather Boots"
+      ]
+    },{
+      "name": "Hard",
+      "startingLife": 8,
+      "staringMoney": 125,
+      "enemyLifeFactor": 1.5,
+      "spawnRank": 2,
+      "sellFactor": 0.25
+    }
+  ]
+}
+```
+
+
+# Fields:
+
+## **screenWidth**  
+## **screenHeight**  
+Logical screen with/height, changing this would require to change all ui elements and won't increase resolution.
+
+## **skin** 
+path to the used skin for adventure
+
+## **playerBaseSpeed** 
+base speed of player character
+
+## **minDeckSize** 
+minimum deck size for matches, decks with lesser cards will be filled with wastes.
+
+## **starterDecks** 
+string list of all starter decks
+## **restrictedCards**
+string list of restricted cards, those cards won't appear in random shops or rewards but it it still possible to get those cards if the plane specifically drops it.
+## **restrictedEditions**
+string list of restricted editions, behaves the same as restricedCards but with editions.
+
+## **difficulties** 
+list of DifficultyData
+## **legalCards** 
+RewardData for legal cards, behaves similar as restrictedCards only as white list and not black ist.
+Also it is defined as RewardData see [Create-Rewards](https://github.com/Card-Forge/forge/wiki/Create-Rewards) for syntax

docs/Configure-Sets.md

@@ -0,0 +1,23 @@
+In order to edit which sets will show up in random rewards and shop you will need to edit the config file. You can find it here "forgefolder"\res\adventure\common\config.json.  Add the sets you want to have restricted to the "restricted edition" section
+![image](https://github.com/user-attachments/assets/24ad9686-8ec9-453b-a496-03b33c1719f2)
+
+
+
+### Funny
+PCEL, PAST, UGL, UNH, HHO, DS0, PHTR, UST, PUST, PH17, PH18, CMB1, UND, PH19, PH20, PH21, UNF, DA1, PH22, MB2
+
+### Commander
+COM, CM1, C13, C14, C15, C16, C17, CMA, CM2, C18, C19, C20, ZNC, KHC, C21, AFC, MIC, VOC, NEC, NCC, DMC, 40K, BRC, SCD, ONC, MOC, LTC, CMM, WOC, WHO, LCC, MKC, PIP, OTC, M3C, BLC, DSC, PDC
+
+### Starters
+CLU, LTR, CLB, CMD, MB1
+
+### Digital
+PRM, MBP, MED, ME2, ME3, TD0, TD1, ME4, VMA, TPR, PZ1, PZ2, ANA, PANA, HA1, HA2, HA3, AJMP, AKR, ANB, KLR, HA4, HA5, J21, YMID, YNEO, YSNC, HBG, EA1, HA6, YDMU, YBRO, EA2, YONE, SIS, SIR, EA3, HA7, YWOE, YMKM, YOTJ, YBLB, YDSK
+
+### Promos
+DRC94, PHPR, PLGM, PMEI, PARL, PRED, PTMP, JGP, PSTH, PEXO, PALP, PUSG, PAL99, G99, PULG, PUDS, PPTK, PGRU, PWOR, PWOS, PMMQ, PSUS, PAL00, FNM, G00, PELP, PNEM, PPCY, PINV, PAL01, F01, G01, MPR, PPLS, PAPC, PSDG, PODY, PAL02, F02, G02, PTOR, PJUD, PHJ, PAL03, F03, PJJT, G03, P03, OVNT, PLGN, PONS, PSCG, P8ED, PAL04, F04, G04, P04, PDST, P5DN, PMRD, PCHK, PAL05, F05, G05, PJSE, P05, PMPS, PBOK, PSOK, P9ED, PRAV, P2HG, PAL06, DCI, F06, G06, PJAS, P06, PMPS06, PGPT, PCMP, PDIS, PCSP, PTSP, F07, G07, PMPS07, PRES, PPLC, PPRO, PGPX, PFUT, P10E, PLRW, F08, G08, P08, PMPS08, PMOR, P15A, PSHM, PEVE, PALA, PDTP, F09, G09, P09, PMPS09, PBOOK, PCON, PURL, PARB, PM10, PZEN, PDP10, F10, G10, P10, PMPS10, PWWK, PROE, PM11, PSOM, PDP12, F11, G11, OLGC, P11, PMPS11, PW11, PMBS, PNPH, PM12, PISD, PDP13, F12, PIDW, J12, PW12, PDKA, PAVR, PHEL, PM13, PRTR, PDP14, F13, J13, PGTC, WMC, PDGM, PM14, PSDC, PTHS, PDP15, F14, J14, PBNG, PJOU, PCNS, PS14, PPC1, PM15, PKTK, F15, J15, UGF, PFRF, PDTK, PTKDF, PS15, PORI, PSS1, PBFZ, F16, J16, POGW, PSOI, PEMN, PKLD, PS16, F17, J17, PAER, PAKH, PHOU, PS17, PXLN, PSS2, PXTC, J18, PRIX, PNAT, PDOM, PM19, PSS3, PS18, PGRN, PRWK, G18, PF19, PRNA, PRW2, J19, PWAR, PMH1, PM20, PPP1, PS19, PWCS, J20, PF20, PLG20, PL21, PW21, PLG21, Q06, P22, PL22, PW22, GDY, PLG22, SCH, PSVC, P30M, P30A, P30H, PRCQ, BOT, PEWK, P23, PR23, PW23, PL23, SLP, PF23, P30T, PMDA, REX, PF24, PW24, PL24, PSS4, PCBB, PLG24, PLTC, PF25, PSPL, PJSC
+
+### Universes Beyond
+
+40K,SLD,ACR,PCBB,PIP,REX,WHO,LTR,LTC,BOT,HBG,CLB,AFR

docs/Console-and-cheats.md

@@ -0,0 +1,43 @@
+Forge provides an in-game console in adventure mode.
+
+You can access (and close) the console while exploring by pressing F9 (or Fn-F9).
+
+To scroll the console window, click and drag the text box.
+
+## Available commands
+
+| Command Example | Description |
+| -- | -- |
+| resetMapQuests | Resets the map quests, resulting in all side-quest progress being lost and all side-quest types being re-picked |
+| give gold 1000 | Give 1000 gold |
+| give shards 1000 | Give 1000 shards |
+| give print lea 232 | Add an alpha (LEA set code) black lotus (232 collector number) |
+| give item <item name or code?> | Adds an in game item such as leather boots |
+| give set sld | Give 4 copies of every card in the Secret Lair Drop (set code SLD), flagged as having no sell value |
+| give nosell card forest | Gives a forest with no sell value |
+| give boosters leb | Add a booster from beta (LEB set code) |
+| give quest 123 | Add the quest by its number ID |
+| give life 10 | Add 10 life to yourself |
+| give card forest | Adds a forest to your inventory |
+| debug collision | Displays bounding boxes around entities |
+| debug map | TODO |
+| debug off | Turns off previously enable debugging |
+| teleport to 6000 5000 | Moves you 6000 tiles east and 5000 tiles north from the left bottom corner |
+| fullHeal | Returns your health back to baseline |
+| sprint 100 | Increases your speed for 100 seconds | 
+| setColorId R | Sets the player color identity; Probably used for testing and shops |
+| clearnosell | Clears the no sell value flag from all cards you own that are not used in a deck |
+| remove enemy abc | Remove the enemy from the map with the map ID abc |
+| remove enemy all | Remove all the enemies from the map |
+| dumpEnemyDeckList | Print the enemy deck lists to terminal output stream |
+| getShards amount 100 | Similar to give shards command; Gives 100 shards to the player |
+| resetQuests | Resets the world quests. In progress quests are not abandonned or reset including dungeons. Does not reroll abandoned quests. Not really sure what this does. | 
+| hide 100 | Enemies do not chase you for 100 seconds |
+| fly 100 | You can walk over obstacles for 100 seconds |
+| crack | Cracks a random item you are wearing | 
+| spawn enemy Sliver | Spawns a Sliver on your screen |
+| listPOI | Prints all locations in terminal output stream as ID-type pairings |
+| leave | Gets you out of the current town/dungeon/cave |
+| dumpEnemyColorIdentity | Prints all enemies, their colour affinity and deck name to terminal output |
+| heal | Recover your full health |
+| dumpEnemyDeckColors | Prints all decks available to enemies and their affinities |

docs/Create-Enemies.md

@@ -0,0 +1,107 @@
+All Enemies are stored under `res/<AdventureName>/world/enemies.json`
+
+Enemies spawned on the overworld map or on map stages will use this exact template to define their base behavior. These values can be modified or added to with additional settings on an individual enemy basis, details of which can be found within [map instance](Create-new-Maps).
+
+Some ideas for custom enemy cards:
+- basic (CR or at least Alchemy conform) effects for normal mobs to add flavor
+- advanced  + all UN stuff. but their mechanics could be combined in new ways not seen in print
+- boss/rare ones that are balanced around meta mechanics (=quests)
+
+The Json file contains an Array of Objects and each Object is one enemy.  
+EnemyObject:  
+
+```json
+{
+	"name": "Challenger 20",
+	"nameOverride": "Challenger",
+	"sprite": "sprites/monsters/doppelganger.atlas",
+	"deck": [
+		"decks/challenger/challenger_20_allied_fires.dck",
+		"decks/challenger/challenger_20_cavalcade_charge.dck",
+		"decks/challenger/challenger_20_final_adventure.dck",
+		"decks/challenger/challenger_20_flash_of_ferocity.dck"
+	],
+	"ai": "",
+	"randomizeDeck": true,
+	"spawnRate": 0.25,
+	"difficulty": 0.25,
+	"speed": 28,
+	"life": 22,
+	"rewards": [],
+	"colors": "UBRWG",
+	"questTags": [
+		"Challenger",
+		"IdentityUnknown",
+		"BiomeGreen",
+		"BiomeRed",
+		"BiomeColorless",
+		"BiomeWhite",
+		"BiomeBlue",
+		"BiomeBlack"
+	]
+}
+```
+
+# Fields:
+
+## **name**
+String - Has to be unique  
+Name of the enemy, every time an other object will use an enemy, it will refer to this name.  
+
+## **nameOverride**
+String - If provided, this will be displayed in any references to this enemy in the game. If not provided, Name will be used.
+
+## **sprite**
+String - Path to the sprite atlas for the enemy (from `res/<AdventureName>`)  
+In fights against the enemy, the sprite under "Avatar" will be used as avatar picture.  
+Every sprite under  
+"Idle","Walk","Attack","Hit","Death"  
+will be used as animation for the corresponding action.  
+direction can be added to alter the animation depending on the direction like "IdleRight"  
+Supported directions are "Right","Left","Up","Down","RightDown","LeftDown","LeftUp","RightUp"
+ 
+## **deck**
+Array of strings containing paths to the decks used for this enemy (from `res/<AdventureName>`)  
+If no decks are defined then the enemy will act like a treasure chest and give the rewards without a fight.  
+(only for enemies in dungeons)  
+The format for the deck file can be the normal forge *.dck syntax or a json file that will behave like a collection of [rewards](Create-Rewards) to get a random generated deck.  
+
+## **randomizeDeck**
+Boolean - if true then the enemy deck will be randomly selected from the deck array. If false, an algorithm will select a deck in sequential order based on the player's prior win/loss ratio against that opponent (discouraged and currently unused due to wild swings in ratio at low game count).
+
+## **ai**
+String - Currently unused, this appears to be intended to allow different playstyles to be associated with this enemy.
+
+## **boss**
+Boolean - Not used to any great extent at this time, but a value of true in this field indicates that this is a boss-level enemy for which the match presentation can be changed if desired. Currently, this causes capable Android devices to vibrate for a longer period on collision with the enemy sprite.
+
+## **flying**
+Boolean - If true, this enemy ignores terrain collisions and can travel freely in their intended movement direction.
+
+## **spawnRate**
+Decimal - Relative frequency with which this enemy will be picked to spawn in appropriate biomes (which are set in the biome json file). Existing values range from 0 to 1.0.
+
+## **difficulty**
+Decimal - Relative estimated difficulty associated with this enemy. Currently unused, but will likely be factored in as a part of filtering enemies into early/late game appropriate opponents. Existing values range from 0 to 1.0.
+
+## **speed**
+Integer - Movement speed of this enemy in overworld or on a [map instance](Create-new-Maps). For comparison, the player's base speed is set at a value of 32 (before any equipment / ability modifiers).
+
+## **scale**
+Decimal - Default 1.0. For enemies whose sprites are too large or small for their intended usage, this serves as multiplier for the enemy's visual dimensions & collision area. By default, we work with 16x16 pixel sprites for most entities - this can be replicated with a more detailed 32x32 sprite by setting a scale of 0.5 for the enemy entry.
+
+## **life**
+Integer - Base starting life total. This is modified universally by a value determined by the player's chosen difficulty, and can be adjusted further at the enemy object level on [map instances](Create-new-Maps).
+
+## **rewards**
+Array - A collection of the rewards to be granted for defeating the enemy.  
+see [Create Rewards](Create-Rewards) for the syntax.
+
+## **equipment**
+Array - A collection of strings representing [equipment items](adventure-items) normally intended for player use that this enemy will have. Not used widely, usually when an enemy will drop that [equipment](adventure-items) and it does not use [mana shards](mana-shards).
+
+## **colors**
+String - Any combination of "B" (Black), "U" (Blue), "C" (Colorless), "G" (Green), "R" Red, and "W" (White). Used to display color identity alongside the sprite when an active ability allows it.
+
+## **questTags**
+Array- A collection of strings associated with this entity for filtering in regards to quests.

docs/Create-Rewards.md

@@ -0,0 +1,178 @@
+Rewards represent anything that can be obtained by the player in Adventure Mode. Cards are the most common type of reward, but rewards can also represent a pieces of equipment, gold, mana shards, maximum life increases, keys, or generic items to be interacted with via dialogs and quests.
+
+Rewards are associated with...
+* Enemies - The loot they drop when defeated.
+* Lootable items - Treasure chests, piles of gold, spellbooks, or mana shards on dungeon maps.
+* Shops - The items available for purchase.
+* Dialog - Items given to the player during a dialog sequence OR required in order to have access to an option.
+* Quests - Rewards for completion of a quest.
+* Events - Rewards for completion of an event.
+
+As a multipurpose concept, Reward data has a large number of fields, but almost all are optional and no one reward will use all of the fields.
+
+The expected fields and behavior for the rewards are set based on the reward's `type` value. This is the one field that all reward data must contain, as it tells the game what other fields to expect data in and how to process them.
+
+The simplest types are `gold` (give the player X gold), `shards` (give the player X [mana shards](mana-shards), and `life` (increase the player's current and maximum life total by this amount [given very sparingly]). Beyond their types, these three items only require a `count` field. Optional fields for these types include `probability` and `addMaxCount`, (see full list at bottom). An example of a `gold` reward that will grant the player 50 gold follows:  
+
+```json
+    {
+      "type": "gold",
+      "count": 50
+    }
+
+```
+
+`Item` rewards are slightly more specific, but still relatively simple, requiring `type`, `count`, and EITHER `itemName` or `itemNames`, examples of both follow. Optional parameters again include `probability` and `addMaxCount`. If `itemName` is specified, then `count` copies of the named item will be granted to the player. If `itemNames` is specified, `count` copies of items randomly selected from the list of named items provided will be granted instead.
+
+```json
+    { 
+      "type": "item",
+      "count":1, 
+      "itemName": "Mithril Boots"
+    }
+```
+
+```json
+    { 
+      "type": "item",
+      "count":1, 
+      "itemNames": ["Mithril Boots", "Mithril Shield", "Mithril Armor"]
+    }
+```
+
+`Card` rewards are potentially the most complex from a definition standpoint, but almost all of the fields are optional. A simple and a complex example follow below. 
+
+Granting the player one completely random card that is legal for use in Adventure:
+```json
+    {
+      "type": "card",
+      "count":1
+    }
+
+```
+
+As a contrasting and complicated example that will return no matching results, consider the card reward data below. 80% of the time, this will try to grant the player 1-9 (modified further by difficulty) cards that are rare, multicolor, contain both red and blue in their color identity, are from M21 or M22 editions, are either instants or creatures, have the Elf subtype, contain the word "dragon" in the card name, contain the word "destroy" and/or "exile" in the card text. Details on the individual fields can be found in the reference list at the bottom of this page.
+```json
+    {
+      "type": "card",
+      "probability": 0.8,
+      "count":1,   
+      "addMaxCount":8, 
+      "colors": ["red","blue"],
+      "rarity": ["rare"],
+      "editions": ["M22","M21"],
+      "cardTypes": ["Instant","Creature"],
+      "colorType": "MultiColor",
+      "subTypes": ["Elf"],
+      "superTypes" :["Legendary"]
+      "cardName": "dragon",
+      "cardText": "destroy|exile"
+    }
+
+```
+
+`Union` reward types are a purely structural element. This reward type does nothing on its own, but it is used as wrappers for multiple `card` instances that has distinctly separate parameters. Required elements are `type` (Union), `count`, and `cardUnion` (which contains additional `card` reward definitions). Optional parameters are, once again `addMaxCount` and `probability`. As an example, the following would award the player with a single red dragon from M21 OR a single green sorcery from M22, but never a red sorcery, M22 dragon, or so on. The individual card pools are conjoined, giving an equal chance of all possible cards across the pools.
+
+```json
+    {
+       "count":1,
+       "type":"Union",
+       "cardUnion": [
+       {
+          "count":1,
+          "editions": ["M21"],
+          "subTypes": ["Dragon"],
+          "colors": ["red"]
+       },
+       {
+          "count":1,
+          "editions": ["M22"],
+          "cardTypes": ["Sorcery"],
+          "colors": ["green"]
+       }
+       ]
+    }
+```
+
+
+
+# Fields:
+
+## **type** 
+Defines the type of reward.  
+Valid options are:
+* `gold` will reward the player with gold.  
+* `life` will increase the maximum life of the player.  
+* `shards` will reward the player with [mana shards](mana-shards).
+* `item` will give items to be added to the player's inventory.
+* `card` will create one or more cards matching a detailed set of filters to follow.
+* `union` is a wrapper for multiple `card` instances that can have mutually exclusive filters.
+* `deckCard` is only used with rewards from [enemies](Create-Enemies), this functions as a `card` reward that is limited to cards found in that enemy's deck.
+
+`{"type": "card", ...}`
+
+## **probability** 
+The probability of this reward being given out, on a decimal scale from 0 to 1. (Defaults to 1 if not provided)
+
+`{..., "probability": 0.5, ...}`
+
+## **count** 
+If given at all (see `probability`, above), get at least this many of the reward.
+
+`{..., "count": 10, ...}`
+
+## **addMaxCount** 
+If given at all, an additional "addMaxCount" instances of the reward will be added. A pre-set multiplier based on the chosen difficulty is applied to this parameter. On normal difficulty, you will get the reward "count" to "addMaxCount" times, `{"type": gold", "count":10, "addMaxCount":5"}` would give anywhere from 10 to 15 gold. (Defaults to 0 if not provided)
+
+`{..., "addMaxCount": 5, ...}`
+
+## **colors**
+An array of the possible colors for `card` and `deckCard`.
+
+`{..., "colors": ["red", "black"], ...}`
+
+## **rarity**
+An array of the possible raritys for `card` and `deckCard`.
+
+`{..., "rarity": ["basicland", "common", "uncommon", "rare", "mythicrare"], ...}`
+
+## **editions**
+An array of the possible editions for `card` and `deckCard`, referenced by their 3 character set code.
+
+`{..., "editions": ["ONE", "MOM", "MAT"], ...}`
+
+## **cardTypes**
+An array of the possible cardTypes for `card` and `deckCard`.  
+
+`{..., "cardTypes": ["Creature", "Artifact", "Enchantment", "Instant", "Sorcery", "Planeswalker", "Battle"], ...}`
+
+## **subTypes**
+An array of the possible subTypes for `card` and `deckCard`.  
+Usually used for creature types, but can also denote names of planeswalkers, types of battles, etc.
+
+`{..., "subTypes": ["Elf", "Dragon", "Gideon", "Urza", "Siege", "Tribal"], ...}`
+
+## **superTypes**
+An array of the possible superTypes for `card` and `deckCard`.  
+
+`{..., "superTypes ": ["Legendary", "Basic", "Snow"], ...}`
+
+## **cardName**
+The exact name of a `card` to use.
+
+`{..., "cardName": "Llanowar Elves", ...}`
+
+## **cardText**
+A regular expression defining text that must appear on the card. A sequence of plain text alphanumeric (A-Z, 0-9) characters can function here if you are unfamiliar with regular expressions, but many special characters will change the functionality. Useful for denoting keywords or identifying helper cards that are associated with but do not actually have a given type.
+
+`{..., "cardText": "reveal the top card of", ...}`
+
+`{..., "cardText": "cast (an instant|a sorcery) from your hand", ...}`
+
+## **deckNeeds**
+This is a functional but partially implemented concept at best, as the result set is currently limited. Card scripts can be tagged as having certain attributes that are used for creating synergies in decks constructed by the game. If/when this feature is expanded to more of our script library, the using those tags will become more and more useful to use for defining rewards so as to allow "concepts" to be awarded as opposed to specific card names or text contents.
+
+`{..., "deckNeeds": ["Ability$Graveyard"], ...}`
+
+## **cardPack**
+This element should not be seen or used in JSON definitions of reward data. `cardPack` rewards are a type that represent a collection of cards whose contents have been pre-determined in game logic (such as a drafted deck that can be kept after an event), but that were not pre-determined at the time when the reward data was written. To manually implement granting specific or randomized cards we should use one or more `card` rewards, detailed above. When granted, this will create an item in the player's inventory that can subsequently be opened by the player to award the individual card contents of the associated deck.

docs/Create-new-Maps.md

@@ -0,0 +1,42 @@
+Maps in the adventure mode are created with the tool Tiled
+ [](https://www.mapeditor.org/)
+
+Open the tiled-project under `<adventure>/maps/main.tiled-project`  
+
+![Screenshot_2021-09-01_140346](https://user-images.githubusercontent.com/8047400/162841209-c9c7aae3-b21d-47ab-9bd4-c9c79fb511bf.png)
+
+This will allow you to edit the maps and tile sets.  
+To interact with the player, objects needs to be added to the Objects layer.  
+
+Objects templates are stored in the "obj" folder, but are not necessary. 
+Impotent are the types of the object and his properties.  
+ 
+## Object types
+
+# enemy
+will spawn an Enemy on the map. On collide with the player a magic duel will be started.  
+If the player win, the enemy will be removed from the map and the player will get the reward.  
+If the player loose, then the player will move 1 step back and receive the standard penalty.  
+Loot is also defined as enemy without a deck, then the player will receive the reward right away.
+Properties:  
+`enemy` name of the enemies
+
+# shop
+Will spawn an shop on the map. On collide the player will enter the shop.
+
+Properties:  
+`shopList` List of possible shop, leave it empty for all shops.  
+`signXOffset` x offset for the shop sign.    
+`signYOffset` y offset for the shop sign.    
+
+# inn
+Will spawn an inn the map. On collide the player will enter the inn.
+
+Properties:   
+# entry 
+Will be used as the map entry and exit. On collide the player will be teleported to an other map or the over world.  
+
+Properties:  
+`direction` the position where to spawn. up means the player will be teleported to the upper edge of the object rectangle.
+`teleport` The map where the player gets teleported. If the property is empty, then the player will be teleported to the over world. 
+`teleportObjectId` the object id where the player will be teleported. If empty then it will search for an entry object, that would teleport the player back to the source map.

docs/Creating-a-Custom-Card.md

@@ -0,0 +1,178 @@
+# Guide - Creating a Custom Card
+
+Using the Forge API you can create your own custom cards and sets. This guide will walk you through the process of creating custom cards via the Force Custom Card Script. 
+
+The next tutorial will walk you through the process of adding your new cards to a custom set. 
+
+
+## File Locations
+
+### Custom Card Scripts
+
+Windows:
+> C:/Users/<your username>/Application Data/Roaming/Forge/custom/cards
+
+Linux:
+> ~/.forge/custom/cards
+
+Mac:
+> TODO Add filepath
+
+### Custom Tokens
+
+Windows:
+> C:/Users/<your username>/Application Data/Roaming/Forge/custom/tokens
+
+Linux:
+> ~/.forge/custom/tokens
+
+Mac:
+> TODO Add filepath
+
+### Custom Editions
+
+> C:/Users/<your username>/Application Data/Roaming/Forge/custom/editions
+
+Linux:
+> ~/.forge/custom/editions
+
+Mac:
+> TODO Add filepath
+
+### Card Images
+
+Windows:
+> C:/Users/<your username>/Application Data/Local/Forge/Cache/pics/cards
+
+Linux:
+> ~/.cache/forge/pics/cards
+
+Mac:
+> TODO Add filepath
+
+## Creating a New Card
+
+In this tutorial we'll create a new card called "Goblin Card Guide".
+
+1. Open Script Directory
+
+Navigate to your Custom Card Scripts folder and open (or create) the subfolder for the starting letter of your new card. 
+In our example:
+> C:/Users/<your username>/Application Data/Roaming/Forge/custom/cards/g
+
+2. Add Card Script
+
+Create a new .txt file using all lowercase letters. Spaces are represented with "_" and you can leave out special characters like commas or apostrophes. 
+> goblin_card_guide.txt
+
+Now we need to define our card. Add the following to your Goblin_Card_Guide text file:
+
+```
+Name:Goblin Card Guide
+ManaCost:1 R
+Types:Creature Goblin
+PT:2/2
+K:Haste
+Oracle:Haste
+```
+
+Let's break our card down:
+ - Name - The name as it appears on the card.
+ - ManaCost - The card's cost with colorless mana first and spaces between different mana symbols.  
+ - Types - The card's type and then any subtypes seperated by spaces. 
+ - PT - Power and Toughness, which is only used for Creatures (or some cards that turn into creatures like Vehicles)
+ - K - A Keyword that gives our creature an ability. 
+ - Oracle - The actual text that appears on that card. 
+
+For a refrence of possible fields and their descriptions please see the [Card Scripting API](Card-scripting-API) document. Note that maintaining an up to date list of every ability of every Magic Card ever printed is not feasable. The API is meant to serve as a guide and includes most common used information. 
+
+3. Add Card to a Set
+
+Now that we have a new card we need to add it to a set so that it will be included in the game. For the purposes of this turorial we'll add out card to an existing set. If you wish to create your own set you can follow this guide: `Guide Coming Soon`
+
+Navigate to your Custom Editions folder and open the text file for the set you would like to add your card to. Let's add our card to the "DCI Promos" set.
+
+In the "CDI Promos.txt" file we can see a list of the cards in the set. Add a new entry at the end of the list for our new card:
+
+```
+78 R Circle of Flame @James Paick
+79 U Stormblood Berserker @Greg Staples
+80 R Dungrove Elder @Scott Chou
+81 R Goblin Card Guide @Forge Team
+```
+
+The first number is the collector number for the card in the set. This must be unique.
+The next field is the card's rarity in the set - we've made our card a rare.
+Next is the card's name and finally the name of the artist for the cards artwork.
+
+Speaking of which - our card doesn't have any artwork. Let's fix that. 
+
+4. Add Card Image
+
+Open your Card Images folder. Find the code for the set you added your new card to and open the corrosponding subfolder. For us this will be:
+
+> C:/Users/<your username>/Application Data/Local/Forge/Cache/pics/cards/PDCI
+
+Add your card image in the folder. Ther are various online tools to create custom cards. For the purposes of the guide you can use this image:
+
+<img src="https://github.com/user-attachments/assets/55363e68-0232-42e2-a1f7-8971686119e6" width="250"/>
+
+5. Add a Triggered Ability
+
+So we've created a creature card and added it to the game. However our creature is a little... boring, so let's update it to have a triggered ability. 
+
+"Whenever Goblin Card Guide deals damage to an opponent, draw a card."
+
+Open the txt file again:
+> goblin_card_guide.txt
+
+And update the contents to the following:
+
+```
+Name:Goblin Card Guide
+ManaCost:1 R
+Types:Creature Goblin
+PT:2/2
+K:Haste
+T:Mode$ DamageDone | ValidSource$ Card.Self | ValidTarget$ Opponent | TriggerZones$ Battlefield | Execute$ TrigDraw | TriggerDescription$ Whenever CARDNAME deals damage to an opponent, draw a card.
+SVar:TrigDraw:DB$ Draw | Defined$ You | NumCards$ 1
+Oracle:Haste
+\nWhenever Goblin Card Guide deals damage to an opponent, draw a card.
+```
+
+Let's take a look at our changes:
+ - T:Mode$ DamageDone - Trigger when Damage is Done.
+ - ValidSource$ Card.Self - The source of the trigger. "Self" means our our card must be the source of the damage for the trigger to occur.
+ - ValidTarget$ Opponent - The target of the trigger. "Oppenent" means our oppenent must receive damage for the trigger to occur.
+ - TriggerZones$ Battlefield - Means the card must be on the battlefield for the trigger to occur.
+ - Execute$ TrigDraw - What happens then the trigger occurs - in this case trigger a Draw effect.
+ - SVar:TrigDraw:DB$ Draw - A String Variable used by the script. This one takes the Triggered Draw (TrigDraw) and tells the script to draw a card. "DB$ Draw" means "Drawback" "Draw".* 
+ - Defined$ You - Who is drawing the card(s), in this case the controller of the card.
+ - NumCards$ 1 - Draw 1 card. This could be changed to any number to trigger drawing that many card. 
+ - TriggerDescription$ - The description of the trigger.
+
+*"Drawback" is a connotation that has since been replaced with "SubAbility".
+The original connotation differentiated between AB (Ability), SP (Spell) and DB (Drawback).
+AP and SP require costs, whereas Drawback do not. The card scripts still use the "DB$" connotation.
+
+6. Updating our Image
+
+Finally since we createda new effect on our card, we need to update the image. Card images are simply .jpg files and don't update or read from any scripts or gamefiles. 
+
+I used the same online card creator to make the change to our card:
+
+<img src="https://github.com/user-attachments/assets/9c1df095-7d94-4a1a-a30f-9d0f64f6da38" width="250"/>
+
+Simply save and rename the image to "Goblin Card Guide.fullborder.jpg" then overwrite the previous file we used in:
+
+> C:/Users/<your username>/Application Data/Roaming/Forge/custom/cards/g
+
+7. Next Steps
+
+You can check the [Abilities](AbilityFactory) and [Triggers](Triggers) documentation for more information on this topic. These documents are meant as a guide and are unlikely to contain information about every ability in the game.
+
+The sinplest method for creating an effect on your card is to find another card that does the same thing and copying the ability. These can be found in your Forge folder:
+
+>./Forge/res/cardsfolder/cardsfolder.zip
+
+Unzipping this file will sllow you to search for any card in the containing subfolders. 

docs/Creating-a-custom-set.md

@@ -0,0 +1,258 @@
+# Creating a custom set
+
+This is a tutorial to start creating your own custom set, or implementing an existing one. We'll take you step by step into implementing a few cards from [MSEM Champions](https://msem-instigator.herokuapp.com/set/MPS_MSE). This is a basic guide to help you get started.
+
+**Note:** This tutorial is currently for **Windows only**.
+
+## Where do the files go?
+
+### Non-image files
+
+Everything but your cards images go into `%appdata%/Forge/custom`. You will need to put the files in the correct directories in order for the game to load them correctly.
+
+The important folders are the following (you can create them if they don't exist):
+
+* **cards**: Your card rules (logic) go inside this folder (.txt). I suggest you create subfolders inside it to keep everything clean.
+* **editions**: Your editions (sets) definition files (.txt) go inside this folder.
+* **tokens**: Your tokens definition files (.txt) go inside this folder.
+
+### Image files
+
+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`. 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
+
+As mentioned in the opening section, we'll be partially implementing the **MSEM Champions** set. Let's create a new text file (.txt) inside `%appdata%/Forge/custom/editions`. Let's name it `MSEM Champions.txt`.
+
+> Note: The file's name don't matter, but it'll be easier to find it if you ever need to edit anything.
+
+Let's paste the following inside it:
+
+```
+[metadata]
+Code=MSEM_CHAMPIONS
+Name=MSEM Champions
+Date=2017-10-01
+Type=Custom
+
+[cards]
+7 M Master Chef
+33 M Golden Touch
+34 M Avatar of Basat
+35 M Exeunt
+62 M Unearth
+78 M Fox of the Orange Orchard
+78★ S Fox of the Orange Orchard
+107 M Inked Summoner
+107★ S Inked Summoner
+130 M Plains
+131 M Island
+132 M Swamp
+133 M Mountain
+134 M Forest
+
+[tokens]
+b_1_1_bird_flying
+b_3_3_cat_deathtouch
+b_5_5_golem_trample
+
+[CreatureTypes]
+Artist:Artists
+```
+
+Let's break it down.
+
+```
+[metadata]
+Code=MSEM_CHAMPIONS
+Name=MSEM Champions
+Date=2017-10-01
+Type=Custom
+```
+
+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.
+
+```
+[cards]
+7 M Master Chef
+34 M Avatar of Basat
+35 M Exeunt
+62 M Unearth
+78 M Fox of the Orange Orchard
+78★ S Fox of the Orange Orchard
+107 M Inked Summoner
+107★ S Inked Summoner
+130 L Plains
+131 L Island
+132 L Swamp
+133 L Mountain
+134 L Forest
+```
+
+The **[cards]** section contains the cards of your edition. Any card appearing under this section has a chance to appear as a reward and in shops.
+
+Each line is as follow: `CollectorNumber Rarity CardName @ArtistName`.
+
+* The collector number should be unique in a given set. You can see some numbers have a ★ next to their name. In this case it denotes an alternate art of a card, but it could also have been a different number altogether.
+  > Note: While it generally doesn't matter what collector number you use, avoid using the collector number F followed by only digits (ie. `F001`) as it represents a "Funny" card inside a normal edition. (Think of Funny cards as Un- sets cards)
+* The rarity is a one letter representation. It can be L (Basic Land), C (Common), U (Uncommon), R (Rare), M (Mythic Rare), S (Special).
+* The card name is self-explanatory. It should match the name of the corresponding card rule. (More of that later)
+* The artist is optional, but it should be `@Artist Name` if present. We'll omit it in this tutorial.
+
+> Note: You can put the cards in the list even if they aren't scripted yet. Forge will skip over them.
+
+```
+[tokens]
+b_1_1_bird_flying
+b_3_3_cat_deathtouch
+b_5_5_golem_trample
+```
+
+The **[tokens]** section is optional, and only needed if you want to use specific token images in this set. They should be named using the name of their token script. `b_1_1_bird_flying` means it is a black 1/1 bird with flying. More on that later.
+
+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:
+
+```
+[cards]
+#7 M Master Chef
+33 M Golden Touch
+...
+```
+
+Save your file, and let's move onto another step.
+
+## Scripting your first cards
+
+As mentioned earlier, your custom card rules need to be located inside `%appdata%/Forge/custom/cards`. I recommend creating subfolders for each starting letter (`Forge/custom/cards/a`, `Forge/custom/cards/b`, etc.) to quickly find if a card has a duplicate name.
+
+Now, you might remember than Unearth was an existing MTG card so we do not need to create a custom card rule for it. Let's create a few others.
+> This tutorial will not teach you to script your cards, and they might not be perfect. Please check out [Creating a Custom Card](https://github.com/Card-Forge/forge/wiki/Creating-a-Custom-Card) if you want more info, or look at the existing cards to learn more complex scripting.
+
+Let's create the following files:
+
+avatar_of_basat.txt
+```
+Name:Avatar of Basat
+ManaCost:R
+Types:Creature Avatar
+PT:2/1
+S:Mode$ CantBlock | ValidCard$ Card.Self | Description$ CARDNAME can't block.
+K:Menace
+Oracle:Menace\nAvatar of Basat can't block.
+```
+
+exhunt.txt
+```
+Name:Exeunt
+ManaCost:B
+Types:Instant
+A:SP$ Sacrifice | SacValid$ Creature | Defined$ Player | SpellDescription$ Each player sacrifices a creature.
+AI:RemoveDeck:All
+Oracle:Each player sacrifices a creature.
+```
+
+fox_of_the_orange_orchard.txt
+```
+Name:Fox of the Orange Orchard
+ManaCost:1 W
+Types:Creature Fox Spirit
+PT:3/1
+Oracle:
+```
+
+inked_summoner.txt
+```
+Name:Inked Summoner
+ManaCost:1 B
+Types:Creature Human Warlock Artist
+PT:1/2
+T:Mode$ Phase | Phase$ End of Turn | ValidPlayer$ You | TriggerZones$ Battlefield | Execute$ TrigBranch | CheckSVar$ X | SVarCompare$ GE2 | TriggerDescription$ 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. If you lost 4 or more life this turn, instead create a 3/3 black Cat creature token with deathtouch. If you lost 6 or more life this turn, instead create a 5/5 black Golem creature token with trample.
+SVar:TrigBranch:DB$ Branch | BranchConditionSVar$ Y | TrueSubAbility$ TrigBranch2 | FalseSubAbility$ DBBird
+SVar:TrigBranch2:DB$ Branch | BranchConditionSVar$ Z | TrueSubAbility$ DBGolem | FalseSubAbility$ DBCat
+SVar:DBBird:DB$ Token | TokenScript$ b_1_1_bird_flying | TokenAmount$ 1
+SVar:DBCat:DB$ Token | TokenScript$ b_3_3_cat_deathtouch | TokenAmount$ 1
+SVar:DBGolem:DB$ Token | TokenScript$ b_5_5_golem_trample | TokenAmount$ 1
+SVar:X:PlayerCountPropertyYou$LifeLostThisTurn
+SVar:Y:Count$Compare X GE4.1.0
+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. 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!
+
+## Scripting custom tokens
+
+The token scripts are located at `%appdata%/Forge/custom/tokens`.
+
+Let's add the new tokens we need to make Inked Summoner work!
+> Just like for card scripting, this tutorial will not teach you about scripting them.
+
+b_1_1_bird.flying.txt
+```
+Name:Bird Token
+ManaCost:no cost
+Colors:black
+Types:Creature Bird
+PT:1/1
+K:Flying
+Oracle:Flying
+```
+
+b_3_3_cat_deathtouch.txt
+```
+Name:Cat Token
+ManaCost:no cost
+Colors:black
+Types:Creature Cat
+PT:3/3
+K:Deathtouch
+Oracle:Deathtouch
+```
+
+b_5_5_golem_trample.txt
+```
+Name:Golem Token
+ManaCost:no cost
+Colors:black
+Types:Creature Golem
+PT:5/5
+K:Trample
+Oracle:Trample
+```
+
+Great! Now Inked Summoner no longer make the game crash! Now let's add some images to spice it all up.
+
+## Adding card and token images
+
+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 `%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)
+![b_5_5_golem_trample](https://github.com/user-attachments/assets/7ff44dc7-0284-48bd-9233-785ac79106f3)
+
+You can now start your game again, and see that the art loads correctly now.
+
+## 🎉 Congratulations!
+
+You’ve just added your first custom set in Forge! There's still much more to explore — scripting advanced abilities, custom mechanics, and set structures — but you now have a solid foundation to build from.

docs/Credit-and-Thanks.md

@@ -0,0 +1,34 @@
+## Special Thanks
+
+1. Quest icons created by Teekatas, from his Legendora set - [Link](http://raindropmemory.deviantart.com/)
+1. Thanks to the XMage team for permission to use their targeting arrows.
+1. Thanks to http://www.freesound.org/browse/ for providing some sound files.
+1. Credit to Kevin Macleod for the royalty free music that is used.
+1. Credit to Juhani Junkala for the royalty free music for boss battles - [Link](https://opengameart.org/content/boss-battle-music)
+
+## Adventure Mode Sprites and tiles. 
+
+Some of the sprites and tiles that are used in Adventure mode come from external artists. These fall under the ownership of their respective artists and may be used only under the conditions laid out in their respective licence.
+
+1. Credit to Reddit user [wampastompah](https://www.reddit.com/user/wampastompah) for the sprites of iconic MTG characters that are used in Adventure mode
+1. Credit to [Aleksandr Makarov's](https://itch.io/profile/iknowkingrabbit) pixelart (tiles and sprites) that are used in Adventure mode.
+1. Credit to [Elthen](https://linktr.ee/elthen) for his sprites that are used in adventure mode.
+1. Credit to [DeepDiveGameStudio](https://deepdivegamestudio.itch.io) for some of the sprites that are used in adventure mode.
+1. Credit to [Krishna Palacio](https://itch.io/profile/krishna-palacio) for some of the sprites and tiles that are used in adventure mode.
+1. Credit to https://opengameart.org/ for some of the tiles. More in dept creditation of the tiles used can be found [Here](https://docs.google.com/spreadsheets/d/e/2PACX-1vTD0L8yDltZnn4025CZ9exhziCj0rbpd2aKE-0qeHikVBz51OKaAHLsgFuaDuIWrkrqIJicxzdn3SG1/pubhtml)
+
+## Soundtrack
+
+### Adventure
+1. Battle = Rising Legion - Derek Fiechter//Assyrian Fortress - Derek Fiechter//Goblin Raid - Brandon Fiechter//  As we Marched -  Vindsvept //  Mecha Dwarves - Derek Fiechter
+1. Boss = 
+1. Inn= Wild Boar's Inn - Brandon Fiechter// Black Rock - Logan Epic Canto //The Land of Gnomes - Logan Epic Canto//Dance of the Red Lights- Logan Epic Canto // Poland - Brandon Fiechter // Tir Nan Og - Logan Epic Canto // Village Consort -Kevin Macleod
+1. Dungeon = Swamp Witch - Derek Fiechter // Giant Mushrooms - Derek Fiechter// Cobweb Fairies - Derek Fiechter
+1. Menus = Vindsvept - Wanderer // Vindsvept - Lake of Light
+1. Waste biome = Vindsvept - Through the Woods we Ran // Vindsvept - Adventure
+1. Swamp biome = Merky Swamp - Brandon Fiechter // Masquerade of the Ghosts - Brandon Fiechter
+1. Island biome = Pirates of the Coast - Brandon Fiechter & Derek Fiechter//Buried Treasure - Brandon Fiechter & Derek Fiechter
+1. Forest biome = Enchanted Forest - Logan Epic Canto // The Celtic King
+1. Plains biome = Cobblestone Village - Brandon Fiechter //  Camelot - Brandon Fiechter
+1. Mountain biome = Goblin Tinker - Brandon Fiechter // Goblin King's Tavern - Brandon Fiechter
+1. Castle = Horus - Brandon Fiechter & Derek Fiechter

docs/Currency.md

@@ -0,0 +1,46 @@
+There are many currencies in the game, and most of them can be interchanged.
+
+# Cards
+
+Acquired by:
+- World drops
+- Match reward
+- Draft wins
+- Shop purchases
+- Quests
+
+Spent on:
+- Selling to shops
+
+# Gold
+
+Acquired by:
+- World drop
+- Match reward
+- Draft reward
+- Quests
+
+Spent on:
+- Cards and items from shops
+- Drafts games
+- Crafting cards
+- Shards
+
+# Shards
+
+Acquired by
+- World drop
+- Quest reward
+
+Spent on
+- Crafting cards
+- Shop Re-rolls
+- Gold exchange
+
+# Challenge Coins
+
+Acquired by
+- At the start of the game
+
+Spent on
+- Drafts

docs/Custom-Music.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/Deck-Building-Tips.md

@@ -0,0 +1,28 @@
+# Adding basic lands and special arts
+
+You can add lands by clicking the triple dots icon in the right top of the deck building interface.
+
+Initially you only have access to jumpstart basic land arts - to get more, you need to purchase the landscape sketch books from the basic land shop (The Cartographers Guild).
+
+# 40-card deck recommendation
+
+40-card decks give you a much more predictable curve.
+
+In a 40-card deck, each individual card has a 2.5% chance of being drawn.
+
+In a 60-card deck, each individual card has a 1.6% chance of being drawn.
+
+When you use a smaller deck, the significance of each individual card is much higher and will give you more predictable performance.
+
+# Autosell
+
+When you click a card that is not part of any decks, you get the option to move it to auto-sell.
+
+The numbers in the interface indicate how many copies you have.
+
+To sell the cards you have marked, go to any town and enter the Inn.
+In the Inn, the middle icon of the coin called Sell (E) will sell all your cards you have marked to sell.
+
+Individual card values vary by rarity and reputation with the town you sell them in.
+
+Since dying will cause you to lose a percentage of your gold, you may want to not sell all your cards immediately.

docs/Development/Android-Builds.md

@@ -0,0 +1,46 @@
+In order to build and sign the android release, you will need the `forge.keystore` file (which is not present in the repository).  This file will need to be placed in the `forge-gui-android` folder.  This file should **never** be committed to the repository.
+
+In preparation for the android release, update the version recorded in the following files:
+
+```
+forge-gui-android/pom.xml
+forge-gui-ios/pom.xml
+forge-gui-mobile/src/forge/Forge.java
+```
+
+In the first two, you're looking for `alpha-version` (~line 10 in both files) and setting the string accordingly.
+In the last one, you're looking for the declaration of `CURRENT_VERSION` (~line 37) and setting it to the same value as the previous two files.
+
+Commit the changes to these three files to the repository with an appropriately descriptive commit message.
+
+A script such as the following will compile and sign the android build:
+
+```
+export ANDROID_HOME=/opt/android-sdk/
+export _JAVA_OPTIONS="-Xmx2g"
+mvn -U -B clean \\
+    -P android-release-build,android-release-sign \\
+    install \\
+    -Dsign.keystore=forge.keystore \\
+    -Dsign.alias=Forge \\
+    -Dsign.storepass=${FORGE_STOREPASS} \\
+    -Dsign.keypass=${FORGE_KEYPASS}
+```
+
+Once the above build has successfully completed and passed any desired testing, the following will build, sign, and publish the build:
+
+```
+export ANDROID_HOME=/opt/android-sdk/
+export _JAVA_OPTIONS="-Xmx2g"
+mvn -U -B clean \\
+    -P android-release-build,android-release-sign,android-release-upload \\
+    install \\
+    -Dsign.keystore=forge.keystore \\
+    -Dsign.alias=Forge \\
+    -Dsign.storepass=${FORGE_STOREPASS} \\
+    -Dsign.keypass=${FORGE_KEYPASS} \\
+    -Dcardforge.user=${FORGE_FTP_USER} \\
+    -Dcardforge.pass=${FORGE_FTP_PASS}
+```
+
+After this, the appropriate forum posts will need to be made announcing the new release.

docs/Development/Android-Debugging.md

@@ -0,0 +1,139 @@
+1. Setup IntelliJ with Android (plugin, SDKs etc).
+2. Get the Android 13 image for the emulator (important: Android 13), then run the emulator. *Skip this step if you use a physical device.*
+3. Make sure you can build the APK.  
+    a. `mvn clean verify -P android-debug` using the working directory forge-gui-android/
+4. Use `android-debug` profile for creating the debug version from below in the forge-gui-android/pom.xml
+5. Use this maven command: `mvn android:deploy-apk android:run`
+6. Look at the emulator (or device), it should say "Waiting for debugger to connect".
+7. CRTL+SHIFT+A in IntelliJ and type in `attach android` and click on "Attach Debugger to Android Process".
+8. Tick "Show all processes" and you should be able to pick `forge.app` from the list and click "Okay".
+9. Ready to debug  
+
+Profile XML for debugging:
+```
+        <profile>
+            <id>android-debug</id>
+            <properties>
+                <android.debug>true</android.debug>
+                <android.run.debug>true</android.run.debug>
+                <android.deployapk.filename>target\forge-android-${snapshot-version}-aligned-debugSigned.apk</android.deployapk.filename>
+                <packaging.type>apk</packaging.type>
+            </properties>
+            <build>
+                <plugins>
+                    <plugin>
+                        <artifactId>exec-maven-plugin</artifactId>
+                        <version>3.4.1</version>
+                        <groupId>org.codehaus.mojo</groupId>
+                        <executions>
+                            <execution>
+                                <id>SignV2</id>
+                                <phase>verify</phase>
+                                <goals>
+                                    <goal>exec</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                        <configuration>
+                            <workingDirectory>${pom.basedir}</workingDirectory>
+                            <executable>java</executable>
+                            <arguments>
+                                <argument>-jar</argument>
+                                <argument>${pom.basedir}/tools/uber-apk-signer.jar</argument>
+                                <argument>-a</argument>
+                                <argument>${pom.basedir}/target/</argument>
+                                <argument>--debug</argument>
+                            </arguments>
+                        </configuration>
+                    </plugin>
+                    <plugin>
+                        <groupId>com.github.cardforge.maven.plugins</groupId>
+                        <artifactId>android-maven-plugin</artifactId>
+                        <dependencies>
+                            <dependency>
+                                <groupId>javax.xml.bind</groupId>
+                                <artifactId>jaxb-api</artifactId>
+                                <version>2.3.1</version>
+                            </dependency>
+                            <dependency>
+                                <groupId>com.sun.xml.bind</groupId>
+                                <artifactId>jaxb-impl</artifactId>
+                                <version>2.3.4</version>
+                            </dependency>
+                            <dependency>
+                                <groupId>sun</groupId>
+                                <artifactId>misc</artifactId>
+                                <version>1</version>
+                                <scope>system</scope>
+                                <systemPath>${pom.basedir}/libs/sun-misc.jar</systemPath>
+                            </dependency>
+                        </dependencies>
+                        <version>4.6.2</version>
+                        <extensions>true</extensions>
+                        <configuration>
+                            <sign>
+                                <debug>false</debug>
+                            </sign>
+                            <sdk>
+                                <platform>${androidPlatform}</platform>
+                                <buildTools>${androidBuildTools}</buildTools>
+                            </sdk>
+                            <dexForceJumbo>true</dexForceJumbo>
+                            <assetsDirectory>${project.basedir}/assets</assetsDirectory>
+                            <resourceDirectory>${project.basedir}/res</resourceDirectory>
+                            <nativeLibrariesDirectory>${project.basedir}/libs</nativeLibrariesDirectory>
+                            <extractDuplicates>true</extractDuplicates>
+                            <proguard>
+                                <skip>false</skip>
+                                <config>${project.basedir}/proguard.cfg</config>
+                            </proguard>
+                            <proguardProguardJarPath>${pom.basedir}/tools/proguard.jar</proguardProguardJarPath>
+                            <release>false</release>
+                            <dexCompiler>d8</dexCompiler>
+                            <d8>
+                                <minApi>26</minApi>
+                                <jvmArguments>
+                                    <argument>${build.min.memory}</argument>
+                                    <argument>${build.max.memory}</argument>
+                                </jvmArguments>
+                            </d8>
+                            <dex>
+                                <multi-dex>true</multi-dex>
+                                <jvmArguments>
+                                    <argument>${build.min.memory}</argument>
+                                    <argument>${build.max.memory}</argument>
+                                </jvmArguments>
+                                <dexArguments>--min-sdk-version=26</dexArguments>
+                            </dex>
+                        </configuration>
+                        <executions>
+                            <execution>
+                                <id>update-manifest</id>
+                                <goals>
+                                    <goal>manifest-merger</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                    <plugin>
+                        <groupId>se.bjurr.gitchangelog</groupId>
+                        <artifactId>git-changelog-maven-plugin</artifactId>
+                        <version>2.2.0</version>
+                        <inherited>false</inherited>
+                        <executions>
+                            <execution>
+                                <id>GenerateGitChangelog</id>
+                                <phase>generate-sources</phase>
+                                <goals>
+                                    <goal>git-changelog</goal>
+                                </goals>
+                                <configuration>
+                                    <skip>true</skip>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+```

docs/Development/Deck-Generation.md

@@ -0,0 +1,8 @@
+This is based on Latent Dirichlet allocation:
+
+1) use Agetian's getmtgdecks.sh scripts to download recent decks from mtgdecks.net and convert them to forge format and separate into Standard/Modern/Pioneer using his python tools (deck2forge_3.5.py and deckSorter_1.4a)
+2) copy the new decks into forge-gui/res/deckgendecks/$format for each format and remove the $format.lda.dat and $format.raw.dat files from that folder
+3) check out the Austin/ldastream branch and merge it with the latest
+4) run the forge.deck.generate.LDAModelGenerator class in the forge-gui-desktop module
+this will generate updated .raw.dat and .lda.dat files that can then be checked in
+probably need to do step 3 before 2 actually

docs/Development/DevMode.md

@@ -0,0 +1,183 @@
+Developer Mode is a Mode that allows Developers to try out different
+things and gain different shortcuts during play. In a Normal program,
+this Mode would be available in a Debug build, but removed from the code
+during the Retail build. Since Forge is in constant Beta, this Mode is
+available during our Beta releases. On the NewGame Screen, just make
+sure it's checked and you'll be able to edit the options at any point
+during the game.
+
+## Lose By Decking
+
+This one is a simple Checkbox. If your Library is Empty and you try to
+try a card, you normally lose the game. This checkbox should be on by
+Default (meaning you lose) but if you are running a deck without many
+cards, uncheck this box so you don't lose when failing to draw a card
+when you need to.
+
+\[THIS OPTION NOT READILY VISIBLE IN VERSIONS 1.6.23\]
+
+## View Zone
+
+There are a few View Zone menu item which help to make sure your Library
+has what you think or the AI isn't being too overly foolish. They do
+exactly what you might think. Click on the menu item, and all Cards in
+that Zone are revealed to you.
+
+## Generate Mana
+
+Useful for not needing Land in your Deck while you are just trying to
+test something out, by selecting Generate Mana, 7 of each color and 7
+colorless is generated and put into your Mana Pool.
+
+## Setup Game State
+
+The Setup Game State is a Command that lets you open an external file to
+Add things into the Game State. Currently the command uses an external
+text file that is opened through a file open dialog when you click on
+the Setup Game State menu item. The file structure is simple. It must
+contain any of the following lines defining what needs to be changed in
+the current game state:
+
+### HumanLife
+
+Defines the value to set the human's current life to. Example:
+HumanLife=6
+
+### AILife
+
+Defines the value to set the computer opponent's life to. Example:
+AILife=14
+
+### HumanCardsInPlay
+
+Defines the cards that are to be placed under Human's control on the
+battlefield. Can be just one card name or a list of card names separated
+with semicolons. Example: HumanCardsInPlay=Swamp; Swamp; Drudge
+Skeletons
+
+### AICardsInPlay
+
+Defines the cards that are to be placed under Computer's control on the
+battlefield. Can be just one card name or a list of card names separated
+with semicolons. Example: AICardsInPlay=Island
+
+### HumanCardsInHand
+
+Defines the cards that are to replace the Human's current hand. Old
+cards in the Human's card will be removed. Can be just one card name or
+a list of card names separated with semicolons, see HumanCardsInPlay or
+AICardsInPlay above for examples.
+
+### AICardsInHand
+
+Defines the cards that are to replace the Computer's current hand. Old
+cards in the Computer's card will be removed. Can be just one card name
+or a list of card names separated with semicolons, see HumanCardsInPlay
+or AICardsInPlay above for examples.
+
+### HumanCardsInGraveyard
+
+Defines the cards that are to replace the Human's current graveyard. Old
+cards in the Human's graveyard will be removed. Can be just one card
+name or a list of card names separated with semicolons, see
+HumanCardsInPlay or AICardsInPlay above for examples.
+
+### AICardsInGraveyard
+
+Defines the cards that are to replace the Computer's current graveyard.
+Old cards in the Computer's graveyard will be removed. Can be just one
+card name or a list of card names separated with semicolons, see
+HumanCardsInPlay or AICardsInPlay above for examples.
+
+### HumanCardsInLibrary
+
+Defines the cards that are to replace the Human's current library. Old
+cards in the Human's library will be removed. Can be just one card name
+or a list of card names separated with semicolons, see HumanCardsInPlay
+or AICardsInPlay above for examples.
+
+### AICardsInLibrary
+
+Defines the cards that are to replace the Computer's current library.
+Old cards in the Computer's library will be removed. Can be just one
+card name or a list of card names separated with semicolons, see
+HumanCardsInPlay or AICardsInPlay above for examples.
+
+### HumanCardsInExile
+
+Defines the cards that are to replace the Human's current exile area.
+Old cards in the Human's exile area will be removed. Can be just one
+card name or a list of card names separated with semicolons, see
+HumanCardsInPlay or AICardsInPlay above for examples.
+
+### AICardsInExile
+
+Defines the cards that are to replace the Computer's current exile area.
+Old cards in the Computer's exile area will be removed. Can be just one
+card name or a list of card names separated with semicolons, see
+HumanCardsInPlay or AICardsInPlay above for examples.
+
+### ActivePlayer
+
+Defines the active player that must be given priority when the game
+state is set up. If this line is absent, the current player is not
+changed. There are two valid values for this option: Human and AI. Note
+that this option does not change the current phase, only the current
+player. Example: ActivePlayer=AI
+
+### ActivePhase
+
+Changes the current phase of the game to the one specified. The valid
+values are Untap, Upkeep, Draw, Main1, Declare Attackers, Declare
+Blockers, Main2, End of Turn, and Cleanup. Note that the phase names are
+case-sensitive.
+
+### Comments
+
+Game state files are allowed to have comments - any line that is
+prefixed with a pound sign (\#) is not parsed and is considered to be a
+text fragment. Also, empty lines are ignored. Example: <b>\# This is a
+comment.</b>
+
+### Specifying a Set for Spawned Cards
+
+When specifying card names, you can optionally add the set code by
+appending the pipe sign (|) and the three-letter set code to the card
+name you are spawning. That will allow you to spawn cards from specific
+sets. For example, <b>HumanCardsInPlay=Mountain; Mountain</b> will just
+spawn two Mountains on the human battlefield, using the latest possible
+set for them, while <b>HumanCardsInPlay=Mountain|4ED; Mountain|4ED</b>
+will spawn two Mountains from the 4th Edition on the human battlefield.
+
+### Samples
+
+Here are two examples of valid state configuration files:
+
+    HumanLife=5
+    AILife=6
+    HumanCardsInPlay=Forest; Forest; Forest; Llanowar Elves
+    AICardsInPlay=Mountain; Mountain; Mountain
+    HumanCardsInHand=Island; Raging Goblin
+    AICardsInHand=Swamp; Swamp; Forest
+
+Sets human's life to 5, AI life to 6, puts 3 Forests and Llanowar Elves
+on the human battlefield, puts 3 Mountains on the computer battlefield,
+replaces the human hand with Island and Raging Goblin, replaces the AI
+hand with 2 Swamps and a Forest. Does not add any cards to either
+graveyard and does not replace either library.
+
+    HumanCardsInPlay=Plains|10E
+    AICardsInPlay=Mountain; Raging Goblin
+    AICardsInGraveyard=Force of Nature; Raging Goblin; Amulet of Kroog
+    ActivePlayer=Human
+    ActivePhase=Main1
+
+Does not change the human's life and the AI life, puts a Plains from the
+10th Edition on the human battlefield, puts a Mountain and a Raging
+Goblin on the opponent's battlefield, does not replace the human and the
+AI hands and leaves them intact, and adds Force of Nature, Raging
+Goblin, and Amulet of Kroog to the computer's graveyard. Does not
+replace either library. Sets the current player to Human and the current
+phase to Main 1.
+
+It's important to note you won't get achievements in a game once you started cheating.