Add CI build workflow and README
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,69 @@
|
|||||||
|
name: Build
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
tags: ["v*"]
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- platform: ubuntu-22.04
|
||||||
|
args: ""
|
||||||
|
- platform: windows-latest
|
||||||
|
args: ""
|
||||||
|
runs-on: ${{ matrix.platform }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Install Linux dependencies
|
||||||
|
if: startsWith(matrix.platform, 'ubuntu')
|
||||||
|
run: |
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y libwebkit2gtk-4.1-dev libgtk-3-dev \
|
||||||
|
libayatana-appindicator3-dev librsvg2-dev patchelf
|
||||||
|
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 22
|
||||||
|
cache: npm
|
||||||
|
|
||||||
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
|
|
||||||
|
- uses: swatinem/rust-cache@v2
|
||||||
|
with:
|
||||||
|
workspaces: src-tauri
|
||||||
|
|
||||||
|
- run: npm ci
|
||||||
|
|
||||||
|
- name: Build bundles
|
||||||
|
run: npm run tauri build -- ${{ matrix.args }}
|
||||||
|
|
||||||
|
- name: Upload artifacts
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: kcd2-overlay-${{ matrix.platform }}
|
||||||
|
path: |
|
||||||
|
src-tauri/target/release/bundle/nsis/*.exe
|
||||||
|
src-tauri/target/release/bundle/msi/*.msi
|
||||||
|
src-tauri/target/release/bundle/deb/*.deb
|
||||||
|
src-tauri/target/release/bundle/appimage/*.AppImage
|
||||||
|
if-no-files-found: warn
|
||||||
|
|
||||||
|
release:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/v')
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
steps:
|
||||||
|
- uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
path: artifacts
|
||||||
|
- uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
files: artifacts/**/*
|
||||||
@@ -1,2 +1,69 @@
|
|||||||
# Kingdom-Cheat-Deliverance-2
|
# Kingdom Cheat: Deliverance 2
|
||||||
|
|
||||||
|
A game overlay for **Kingdom Come: Deliverance II** with a searchable database of
|
||||||
|
console commands, items, perks, buffs and skills. Fill in the parameters, hit
|
||||||
|
**Copy**, and paste the finished command into the game console.
|
||||||
|
|
||||||
|
- **Overlay**: frameless, semi-transparent, always-on-top window toggled with a
|
||||||
|
global hotkey (default `Ctrl+Shift+K`); lives in the system tray
|
||||||
|
- **Quick Cheats**: money, skills & XP, god mode, repair, unlocks, teleport, saving
|
||||||
|
- **Commands**: ~120 commands — vanilla `-devmode` commands and the Nexus
|
||||||
|
"Cheat" mod's `cheat_*` commands, each badged by requirement, with argument
|
||||||
|
forms and examples
|
||||||
|
- **Items / Perks / Buffs / Skills**: ~4,900 items, ~880 perks, ~560 buffs and all
|
||||||
|
skills with IDs — set amount/condition/level and copy a ready-made command
|
||||||
|
|
||||||
|
## Game setup
|
||||||
|
|
||||||
|
1. **Borderless window**: set the game's display mode to *borderless window*
|
||||||
|
(an overlay cannot draw above exclusive fullscreen).
|
||||||
|
2. **devmode commands** (green badge): add `-devmode` to the game's launch
|
||||||
|
options (Steam → right-click the game → Properties → Launch Options). Open
|
||||||
|
the in-game console with `~` / `` ` ``.
|
||||||
|
3. **Cheat mod commands** (purple badge): install the free
|
||||||
|
[Cheat mod](https://www.nexusmods.com/kingdomcomedeliverance2/mods/114)
|
||||||
|
from Nexus Mods (also requires `-devmode`).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
- Press the global hotkey (default `Ctrl+Shift+K`) or click the tray icon to
|
||||||
|
show/hide the overlay. Closing the window only hides it; quit from the tray menu.
|
||||||
|
- Change the hotkey, overlay opacity, preferred command flavor, autostart and
|
||||||
|
start-hidden behavior in **Settings**.
|
||||||
|
- **Wayland note**: global hotkeys are unreliable on Wayland. Bind
|
||||||
|
`kcd2-overlay --toggle` to a compositor shortcut instead — a second launch
|
||||||
|
toggles the running instance.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Prerequisites: Rust, Node.js 20+, and on Linux the Tauri system deps
|
||||||
|
(`libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev`).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install
|
||||||
|
npm run tauri dev # development
|
||||||
|
npm run tauri build # release bundles (deb/AppImage on Linux, NSIS/MSI on Windows)
|
||||||
|
```
|
||||||
|
|
||||||
|
Windows builds are produced by the CI workflow in `.github/workflows/build.yml`
|
||||||
|
(GitHub Actions / Gitea Actions with a Windows runner), or locally from Linux
|
||||||
|
with [cargo-xwin](https://github.com/rust-cross/cargo-xwin):
|
||||||
|
`npm run tauri build -- --runner cargo-xwin --target x86_64-pc-windows-msvc`.
|
||||||
|
|
||||||
|
## Data
|
||||||
|
|
||||||
|
Game data under `src/data/` is generated from the
|
||||||
|
[pryans/kcd2-cheat](https://github.com/pryans/kcd2-cheat) repository (the
|
||||||
|
source of the Nexus Cheat mod) and vendored so builds are offline:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
node scripts/fetch-data.mjs # refresh items/perks/buffs/skills + command docs
|
||||||
|
```
|
||||||
|
|
||||||
|
`commands-vanilla.json` and `quick-cheats.json` are hand-curated from
|
||||||
|
community command lists.
|
||||||
|
|
||||||
|
## Disclaimer
|
||||||
|
|
||||||
|
Single-player cheats only. Achievements and game balance are your own
|
||||||
|
responsibility — keep a save from before you start experimenting.
|
||||||
|
|||||||
Reference in New Issue
Block a user