Skip to content

Commit 4ff12c9

Browse files
committed
release: VelocityNavigator 4.3.0
1 parent 6318456 commit 4ff12c9

190 files changed

Lines changed: 12238 additions & 3857 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/build.yml‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,16 @@ on:
77
branches: [main]
88
workflow_dispatch:
99
inputs:
10-
version:
11-
description: 'Release version (e.g. 3.0.0)'
12-
required: true
13-
default: '4.2.0'
1410
create_release:
1511
description: 'Create a GitHub Release?'
1612
required: true
1713
type: boolean
1814
default: true
15+
prerelease:
16+
description: 'Mark the GitHub Release as a prerelease?'
17+
required: true
18+
type: boolean
19+
default: false
1920

2021
jobs:
2122
build:
@@ -40,12 +41,7 @@ jobs:
4041
- name: Resolve Version
4142
id: version
4243
shell: bash
43-
run: |
44-
if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
45-
echo "version=${{ inputs.version }}" >> "$GITHUB_OUTPUT"
46-
else
47-
echo "version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> "$GITHUB_OUTPUT"
48-
fi
44+
run: echo "version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> "$GITHUB_OUTPUT"
4945

5046
- name: Upload JAR Artifact
5147
uses: actions/upload-artifact@v4
@@ -66,4 +62,4 @@ jobs:
6662
body_path: release_notes.md
6763
files: target/VelocityNavigator-*.jar
6864
draft: false
69-
prerelease: false
65+
prerelease: ${{ inputs.prerelease }}

‎CHANGELOG.md‎

Lines changed: 104 additions & 37 deletions
Large diffs are not rendered by default.

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# Contributing to VelocityNavigator
22

3-
First off, thanks for taking the time to contribute! VelocityNavigator is a premium project by **DemonZ Development**, and we appreciate any help in making it better.
3+
Thanks for taking the time to contribute. VelocityNavigator is an open-source project maintained by **DemonZ Development**, and contributions of any size are welcome.
44

55
## How Can I Contribute?
66

77
### Reporting Bugs
8-
Bugs are tracked as GitHub issues. When creating a bug report, please include as many details as possible (logs, Velocity version, etc.).
8+
Bugs are tracked as GitHub issues. When creating a bug report, include as much detail as possible: the Velocity version, the VelocityNavigator version, the relevant section of `navigator.toml`, and any logs or stack traces.
99

1010
### Suggesting Enhancements
11-
Feature requests are also tracked as GitHub issues. We love hearing your ideas!
11+
Feature requests are also tracked as GitHub issues. Describe the problem you are trying to solve and the behavior you expect; concrete examples and proposed config shapes help.
1212

1313
### Pull Requests
1414
- Fork the repository and create your branch from `main`.
15-
- If you've added code that should be tested, add tests!
15+
- If you add code that should be tested, add tests covering it.
1616
- Ensure the test suite passes (`mvn verify`).
17-
- Make sure your code lints.
1817
- Follow the existing code style.
18+
- Keep commits focused — one logical change per branch makes review faster.
1919

2020
## Credits & Attribution
21-
VelocityNavigator is developed and maintained by **DemonZ Development**.
21+
VelocityNavigator is developed and maintained by **DemonZ Development**.
2222

23-
Contributors who have their pull requests merged will be listed in the [CHANGELOG.md](CHANGELOG.md) and on the project page.
23+
Contributors who have pull requests merged are listed in the [CHANGELOG.md](CHANGELOG.md) and on the project page.
2424

2525
## License
26-
By contributing to VelocityNavigator, you agree that your contributions will be licensed under its [Apache License 2.0](LICENSE).
26+
By contributing to VelocityNavigator, you agree that your contributions are licensed under the project's [Apache License 2.0](LICENSE).

‎README.md‎

Lines changed: 174 additions & 89 deletions
Large diffs are not rendered by default.

‎assets/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Marketplace and Brand Assets
2+
3+
Brand artwork and guide headers are generated by `scripts/generate_marketplace_assets.py`. The Java and Bedrock selector images are real in-game screenshots, and the dashboard preview is a real runtime capture. These screenshots are never regenerated by that script.
4+
5+
The same script also writes the compact page headers under `wiki/headers/` so the public guides share the same visual style.
6+
7+
## Brand files
8+
9+
| File | Size | Use |
10+
|---|---:|---|
11+
| `plugin-icon.png` | 1024 × 1024 | Marketplace and wiki icon |
12+
| `logo-mark.png` | 1024 × 1024 | Transparent master mark |
13+
| `hero-banner.png` | 1600 × 500 | README, wiki, and marketplace header |
14+
| `social-post.png` | 1200 × 630 | Release and social preview |
15+
| `java-inventory-selector.png` | 924 × 520 | Real Java Edition inventory selector screenshot |
16+
| `bedrock-selector.png` | 1024 × 528 | Real Bedrock selector screenshot |
17+
| `dashboard-preview.png` | 747 × 1096 | Live operations dashboard with configured and Redis-discovered lobbies |
18+
19+
The visual system uses a navy background, off-white type, and one cyan accent. Avoid adding glow, gradients with heavy bloom, stock gaming artwork, or dense paragraphs inside images.
20+
21+
## Marketplace panels
22+
23+
The `marketplace/` panels are 1200 × 420 PNG files. They are section headers and visual summaries, not replacements for the searchable text below them.
24+
25+
| File | Recommended alt text |
26+
|---|---|
27+
| `01-smart-routing.png` | Player routed to a healthy lobby |
28+
| `02-universal-jar.png` | Universal JAR architecture for Velocity and optional backends |
29+
| `04-resilient-routing.png` | Circuit breaker and health monitoring states |
30+
| `05-optional-systems.png` | Optional party, queue, and Redis systems |
31+
| `06-operations.png` | Network health and operations dashboard |
32+
| `07-localization.png` | Built-in and custom language support |
33+
| `08-defensive-design.png` | Security boundaries for menus, Redis, HTTP, and files |
34+
| `09-compatibility.png` | Velocity and backend bridge compatibility |
35+
| `marketplace-footer.png` | VelocityNavigator documentation and support footer |
36+
37+
## Listing sources
38+
39+
`modrinth-listing.md` is the canonical marketplace body. Run `scripts/generate_marketplace_assets.py` after editing it; the script refreshes `hangar-listing.md` and `spigot-resource.md` with the same feature copy and platform-specific download wording. `spigot-resource.bbcode` is the separately formatted Spigot resource-page source.
40+
41+
Marketplace bodies keep players on their current marketplace for downloads. They must not link to GitHub releases or use GitHub as a download CTA.
42+
43+
Keep critical compatibility, installation, command, permission, and limitation details as real text. Modrinth requires meaningful image alt text, and Spigot's premium guidelines discourage substantive description text being placed only inside images.

‎assets/dashboard-preview.png‎

61.2 KB
Loading

‎assets/feature-routing.png‎

-1.42 MB
Binary file not shown.

0 commit comments

Comments
 (0)