Skip to content

Commit c5f1bda

Browse files
author
BF6 Portal Developer
committed
Docs: add screenshot section + CI
1 parent 00c75d5 commit c5f1bda

File tree

7 files changed

+65
-0
lines changed

7 files changed

+65
-0
lines changed

.github/workflows/ci.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: ["**"]
6+
pull_request:
7+
8+
jobs:
9+
webui-build:
10+
name: Build web_ui
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Setup Node
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: 18
20+
cache: npm
21+
22+
- name: Install root deps
23+
run: npm install
24+
25+
- name: Install web_ui deps
26+
run: npm install --prefix web_ui
27+
28+
- name: Build web_ui
29+
run: npm run build --prefix web_ui
30+
31+
- name: Test web_ui
32+
run: npm test --prefix web_ui

.gitlab-ci.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ stages:
44
- build
55
- release
66

7+
# Run a lightweight CI build on normal branch pushes.
8+
# The full Electron packaging + GitLab Release is reserved for tags.
9+
webui_build:
10+
stage: build
11+
image: node:18
12+
rules:
13+
- if: $CI_COMMIT_TAG
14+
when: never
15+
- if: $CI_COMMIT_BRANCH
16+
script:
17+
- npm install
18+
- npm install --prefix web_ui
19+
- npm run build --prefix web_ui
20+
- npm test --prefix web_ui
21+
722
build:
823
stage: build
924
rules:

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Release notes: see `docs/RELEASE_NOTES_1.2.8.md`.
77

88
**BF6Portal Tool** is a standalone visual logic editor for **Battlefield 6 Portal**, built with **Electron** + **Google Blockly**. It aims to replicate the Portal Rules Editor workflow in a desktop app, with offline editing and quality-of-life tooling.
99

10+
## Screenshot
11+
12+
![BF6Portal Tool editor screenshot](docs/screenshots/editor.png)
13+
1014
## Features
1115

1216
- **Rules toolbox essentials:** a single **RULES** menu containing `MOD_BLOCK`, `RULE_HEADER`, and `CONDITION_BLOCK`.

docs/RELEASE_NOTES_1.2.8.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Release Notes - v1.2.8
22

3+
## Screenshot
4+
5+
![BF6Portal Tool editor screenshot](screenshots/editor.png)
6+
37
## Features & Improvements
48
- **Refined Toolbox Structure:** The Blockly toolbox has been reorganized to better match the official Battlefield Portal Rules Editor layout.
59
- Added distinct "Yellow" (Actions/Statements) and "Green" (Values/Expressions) categories for clearer distinction.

docs/screenshots/.gitkeep

Whitespace-only changes.

docs/screenshots/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Screenshots
2+
3+
Drop screenshots for the README/release notes in this folder.
4+
5+
Recommended names:
6+
- `editor.png` — main editor UI (shows presets dropdown + blocks loaded)
7+
- `selection-lists.png` — selection list dropdown open
8+
9+
Note: The repository currently includes a tiny placeholder `editor.png` so documentation renders cleanly.
10+
Replace it with a real screenshot whenever you're ready.

docs/screenshots/editor.png

68 Bytes
Loading

0 commit comments

Comments
 (0)