Deploy 284fe69 to gh-pages

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Video**
+If applicable, add a video to help illustrate your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Windows]
+ - Version [e.g. 22]
+
+**Environment:**
+ - Launcher: [e.g. Steam]
+ - Game version [e.g. 1.61]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/support_consumable.md

@@ -0,0 +1,27 @@
+---
+name: Support additional consumable
+about: Request support for additional consumable.
+description: This template is mostly used internally by developer.
+title: 'support XXX'
+labels: 'cross over, enhancement'
+assignees: ''
+
+---
+
+implement XXX addiction system, general guideline:
+
+<!-- List all mods with respective consumable implementation. -->
+
+## [MOD X](.)
+
+<!-- Copy/paste image from mod here. -->
+
+<!-- List gameplay mechanics -->
+- [ ] 
+
+## [MOD Y](.)
+
+<!-- Copy/paste image from mod here. -->
+
+<!-- List gameplay mechanics -->
+- [ ] 

.github/workflows/pages.yml

@@ -0,0 +1,53 @@
+name: Pages
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/**"
+      - "book/book.toml"
+      - "book/pages/**"
+      - "**.md"
+env:
+  MDBOOK_VERSION: '0.4.37'
+  MDBOOK_CODEBLOCKS_VERSION: '0.1.14'
+  MDBOOK_ADMONISH_VERSION: '1.15.0'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install mdbook
+        run: |
+          mkdir mdbook
+          curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${{ env.MDBOOK_VERSION }}/mdbook-v${{ env.MDBOOK_VERSION }}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Install mdbook-codeblocks
+        run: |
+          mkdir mdbook-codeblocks
+          curl -sSL https://github.com/Roms1383/mdbook-codeblocks/releases/download/v${{ env.MDBOOK_CODEBLOCKS_VERSION }}/mdbook-codeblocks-v${{ env.MDBOOK_CODEBLOCKS_VERSION }}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook-codeblocks
+          echo `pwd`/mdbook-codeblocks >> $GITHUB_PATH
+      - name: Install mdbook-admonish
+        run: |
+          mkdir mdbook-admonish
+          curl -sSL https://github.com/tommilligan/mdbook-admonish/releases/download/v${{ env.MDBOOK_ADMONISH_VERSION }}/mdbook-admonish-v${{ env.MDBOOK_ADMONISH_VERSION }}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook-admonish
+          echo `pwd`/mdbook-admonish >> $GITHUB_PATH
+      - name: Setup rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Deploy GitHub Pages
+        run: |
+          (cd book && mdbook build)
+          git worktree add gh-pages
+          git config user.name "Deploy from CI"
+          git config user.email ""
+          cd gh-pages
+          # Delete the ref to avoid keeping history.
+          git update-ref -d refs/heads/gh-pages
+          rm -rf *
+          mv ../book/site/html/* .
+          git add .
+          git commit -m "Deploy $GITHUB_SHA to gh-pages"
+          git push --force --set-upstream origin gh-pages

.github/workflows/quality.yml

@@ -0,0 +1,32 @@
+name: Quality
+on:
+  push:
+    paths:
+      - '.github'
+      - 'scripts/Addicted'
+  pull_request:
+    paths:
+      - '.github'
+      - 'scripts/Addicted'
+env:
+  DOTNET_VERSION: '8.0.x'
+  REDSCRIPT_VERSION: '0.5.19'
+  REDSCRIPT_SRC: scripts/Addicted
+
+jobs:
+  redscript:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '${{ env.DOTNET_VERSION }}'
+      - name: Setup REDscript
+        run: C:\msys64\usr\bin\wget.exe https://github.com/jac3km4/redscript/releases/download/v${{ env.REDSCRIPT_VERSION }}/redscript-cli.exe
+      - name: Lint code
+        run: ./redscript-cli.exe lint --src ${{ env.REDSCRIPT_SRC }}
+        continue-on-error: true

.github/workflows/release.yml

@@ -0,0 +1,113 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+      - "rc*"
+      - "beta*"
+      - "alpha*"
+env:
+  WOLVENKIT_CORE_VERSION: '8.14.0'
+  WOLVENKIT_CLI_VERSION: '8.14.0'
+  DOTNET_VERSION: '8.0.x'
+  IS_DRAFT: ${{ startsWith(github.ref_name, 'beta') || startsWith(github.ref_name, 'alpha') }}
+
+jobs:
+  bundle-mod:
+    runs-on: windows-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Just
+        uses: extractions/setup-just@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '${{ env.DOTNET_VERSION }}'
+      - name: Setup WolvenKit CLI
+        run: |
+          C:\msys64\usr\bin\wget.exe https://github.com/WolvenKit/WolvenKit/releases/download/"${{ env.WOLVENKIT_CORE_VERSION }}"/"${{ env.WOLVENKIT_ARTIFACT }}"
+          7z x "${{ env.WOLVENKIT_ARTIFACT }}"
+          dotnet tool install -g wolvenkit.cli
+        env:
+          WOLVENKIT_ARTIFACT: WolvenKit.Console-${{ env.WOLVENKIT_CLI_VERSION }}.zip
+      - name: Bundle files
+        run: just ci 'mod-windows'
+        env:
+          WK_CLI: cp77tools
+      - name: Zip files
+        uses: thedoctor0/[email protected]
+        with:
+          type: 'zip'
+          filename: 'Addicted-mod-windows-${{ github.ref_name }}.zip'
+          directory: ./mod-windows
+          path: .
+          recursive_exclusions: ${{ (env.IS_DRAFT && 'Debug.reds') || '' }}
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: mod-windows-${{ github.ref_name }}
+          path: mod-windows/Addicted-mod-windows-${{ github.ref_name }}.zip
+          if-no-files-found: error
+  bundle-translations:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        locale:
+          - en-us
+          - fr-fr
+          - es-es
+          - zh-cn
+          - pt-br
+          - it-it
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Just
+        uses: extractions/setup-just@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Bundle files
+        run: just bundle 'translation-${{ matrix.locale }}' "${{ matrix.locale }}"
+      - name: Zip files
+        uses: thedoctor0/[email protected]
+        with:
+          type: 'zip'
+          filename: 'Addicted-translation-${{ matrix.locale }}-${{ github.ref_name }}.zip'
+          directory: ./translation-${{ matrix.locale }}
+          path: .
+      - name: Upload translations
+        uses: actions/upload-artifact@v4
+        with:
+          name: translation-${{ matrix.locale }}-${{ github.ref_name }}
+          path: translation-${{ matrix.locale }}/Addicted-translation-${{ matrix.locale }}-${{ github.ref_name }}.zip
+          if-no-files-found: error
+  release:
+    if: ${{ startsWith(github.event.ref, 'refs/tags') }}
+    runs-on: windows-latest
+    needs: [bundle-mod, bundle-translations]
+    steps:
+      - name: Download mod and translations
+        uses: actions/download-artifact@v4
+        with:
+          path: release
+          merge-multiple: true
+      - name: Create release ${{ github.ref_name }}
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: "release/*.zip"
+          draft: ${{ env.IS_DRAFT }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          artifactErrorsFailBuild: true

.gitignore

@@ -0,0 +1,27 @@
+**/*.env
+**/*.log
+**/.DS_Store
+
+/book/site
+scripts/*
+!scripts/Addicted
+/archives/**/*.cpmodproj
+/archives/**/*.zip
+/archives/**/layout.xml
+/archives/**/install_log.xml
+/archives/**/packed
+/archives/*.archive
+/archives/*.xl
+
+/Addicted
+/.VSCodeCounter
+dump.redscripts
+saved.json
+/.installation
+/medium
+/community
+/samples
+
+redscript-cli.exe
+WolvenKit.CLI.exe
+REDmodLog.txt

.markdownlintignore

@@ -0,0 +1,2 @@
+CHANGELOG.md
+NEXUS.txt

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "Lua.runtime.version": "LuaJIT",
+    "Lua.workspace.preloadFileSize": 15360,
+    "Lua.workspace.library": [
+        "C:\\Development\\cet-lua-b-1.18.0-211124"
+    ],
+    "redscript.gameDir": "C:\\Program Files (x86)\\Steam\\steamapps\\common\\Cyberpunk 2077",
+    "redHotTools.gameDir": "C:\\Program Files (x86)\\Steam\\steamapps\\common\\Cyberpunk 2077",
+    "workbench.colorCustomizations": {
+      "activityBar.background": "#1D331E",
+      "titleBar.activeBackground": "#29472A",
+      "titleBar.activeForeground": "#F8FBF8"
+    }
+}