Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions .github/workflows/public-presence.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,41 @@ permissions:
jobs:
validate:
name: Validate organization profile
runs-on: ubuntu-latest
runs-on: ubuntu-24.04
timeout-minutes: 10
defaults:
run:
working-directory: repos/emulebb-org-profile
env:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: 'true'

steps:
- name: Checkout organization profile
uses: actions/checkout@v7
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
with:
path: repos/emulebb-org-profile
persist-credentials: false

- name: Checkout public-presence authority
uses: actions/checkout@v7
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
with:
repository: emulebb/emulebb-tooling
path: .local/emulebb-tooling
ref: 027dcf32aab5ed2d1e3441b6231e8e500cc2e945
path: repos/emulebb-tooling
persist-credentials: false

- name: Set up Python
uses: actions/setup-python@v7
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7
with:
python-version: '3.x'
python-version: '3.15.2'

- name: Validate contract and generated profile
run: |
python .local/emulebb-tooling/helpers/public-presence.py validate
python .local/emulebb-tooling/helpers/public-presence.py check-org-profile --input profile/README.md
python -B ../emulebb-tooling/helpers/public-presence.py validate
python -B ../emulebb-tooling/helpers/public-presence.py check-org-profile --input profile/README.md

- name: Validate documentation links
run: |
python .local/emulebb-tooling/helpers/check-tooling-doclinks.py \
--docs-root .local/emulebb-tooling/docs \
python -B ../emulebb-tooling/helpers/check-tooling-doclinks.py \
--docs-root ../emulebb-tooling/docs \
profile/README.md
6 changes: 4 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ local deltas only.

## Hard Rules

- The org profile is **text-first**. Do not add screenshots, mascot art, copied
application artwork, or other brand image assets unless explicitly approved.
- The org profile is **text-first**, with the operator-approved proposal-1 Rust
donkey identity image as its only in-page artwork. Use the shared contract's
reviewed asset origin, explicit dimensions and descriptive alt text. Do not
regenerate the image or add screenshots and unrelated artwork.
- Treat `emulebb-tooling` active/reference docs as the source of truth. The
profile summarizes and links; it does not invent feature or release facts.
- Treat `emulebb-tooling\manifests\public-presence.v1.json` as the source for
Expand Down
63 changes: 33 additions & 30 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,61 @@
<!-- Generated by emulebb-tooling/helpers/public-presence.py. -->
# eMuleBB

<img src="https://emulebb.github.io/assets/brand/emulebb-logo-256.png" width="160" height="160" alt="eMuleBB Rust pixel donkey identity" />

[![Rust CI](https://github.com/emulebb/emulebb-rust/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/emulebb/emulebb-rust/actions/workflows/ci.yml)
[![MFC baseline](https://github.com/emulebb/emulebb/actions/workflows/baseline.yml/badge.svg?branch=main)](https://github.com/emulebb/emulebb/actions/workflows/baseline.yml)
[![Docs](https://github.com/emulebb/emulebb-tooling/actions/workflows/docs-site.yml/badge.svg?branch=main)](https://github.com/emulebb/emulebb-tooling/actions/workflows/docs-site.yml)

eMuleBB Rust is the active eD2K/Kad beta, backed by a maintained Windows client and focused protocol tooling.

## eMuleBB Rust
**Contents:** [Use or develop](#use-or-develop) · [Repositories](#work-across-the-project) · [Support](#keep-in-touch)

**Active beta.**
eMuleBB Rust is an eD2K/Kad client for Windows, Linux and macOS, operated through a browser console and authenticated REST API.

Repeatedly tested on live eD2K/Kad networks.
**Active beta.** CI-gated nightly builds are the public testing channel. Beta 3 is the next development target.

Beta 3 is expected after a few more weeks of implementation and stabilization.
## Use or develop

- [Choose the newest dated nightly build](https://github.com/emulebb/emulebb-rust/releases)
- [Read the eMuleBB Rust product docs](https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/)
- [Report eMuleBB Rust issues](https://github.com/emulebb/emulebb-rust/issues)
| Use eMuleBB Rust | Develop with eMuleBB Rust |
| --- | --- |
| [First launch and daily use](https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-GETTING-STARTED/) | [Contribute to the client](https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-CONTRIBUTING/) |
| [Choose a platform and package](https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-DOWNLOADS-PLATFORMS/) | [Build against the REST API](https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/api/GUIDE-API-CONSUMERS/) |

## Client Lanes
- **Browser operation:** search eD2K/Kad, manage transfers and monitor chosen shared folders from the packaged console.
- **Automation:** use authenticated REST requests and the documented API contract.
- **Explicit network controls:** review interface settings, connection status and diagnostics.
- **Identifiable builds:** inspect source-bound package manifests, checksums and provenance.

- **[emulebb-rust](https://github.com/emulebb/emulebb-rust) — Active beta.** CI-gated nightly builds from main are the current public testing channel.
[Contributions are welcome.](https://github.com/emulebb/emulebb-rust/blob/main/CONTRIBUTING.md)
- **[emulebb](https://github.com/emulebb/emulebb) — Stable maintenance.** Version 0.7.3 remains published while the 0.7.x line provides diagnostics, critical fixes, and bounded maintenance.
See the platform guide for package checks, network-validation scope and the limits of the published proof.

eMuleBB Rust is the active product-development lane. The MFC client remains the stable Windows diagnostic baseline and may receive critical fixes and bounded, low-risk maintenance.
- [Choose the newest dated nightly build](https://github.com/emulebb/emulebb-rust/releases)
- [Report eMuleBB Rust issues](https://github.com/emulebb/emulebb-rust/issues)

## Repository Status
## Work across the project

| Repository | Role |
| --- | --- |
| [`emulebb-rust`](https://github.com/emulebb/emulebb-rust) | Active Rust beta and current product-development lane. |
| [`emulebb`](https://github.com/emulebb/emulebb) | Stable 0.7.x Windows client, diagnostic baseline, and critical-fix maintenance lane. |
| [`ed2k-server`](https://github.com/emulebb/ed2k-server) | Sole local deterministic eD2K server, maintained as a minimal upstream-aligned Rust fork. |
| [`emulebb-build-tests`](https://github.com/emulebb/emulebb-build-tests) | Shared Rust and MFC diagnostics, compatibility, live-network, and parity harness. |
| [`emulebb-build`](https://github.com/emulebb/emulebb-build) | Workspace, build, validation, packaging, and release orchestration. |
| [`emulebb-tooling`](https://github.com/emulebb/emulebb-tooling) | Public roadmap, lifecycle policy, product docs, and engineering references. |
| [`emulebb-build`](https://github.com/emulebb/emulebb-build) | Workspace, build, validation, packaging, and release orchestration. |
| [`emulebb-build-tests`](https://github.com/emulebb/emulebb-build-tests) | Shared Rust and MFC diagnostics, compatibility, live-network, and parity harness. |

## Compatibility References
## Maintenance and references

| Reference | Role |
| --- | --- |
| [aMule upstream](https://github.com/amule-org/amule) (`master`) | Actively developed upstream client used as the moving interoperability and parity reference. |
| [eMule stock 0.72](https://github.com/irwir/eMule) (`v0.72a`) | Stock compatibility baseline for protocol and state-machine parity. |
eMuleBB Rust is the active product-development lane. The MFC client remains the stable Windows diagnostic baseline and may receive critical fixes and bounded, low-risk maintenance.

- [Stable maintenance downloads](https://github.com/emulebb/emulebb/releases/tag/emulebb-v0.7.3): Version 0.7.3 remains published while the 0.7.x line provides diagnostics, critical fixes, and bounded maintenance.

<details>
<summary>Test infrastructure and compatibility references</summary>

## Releases And Historical Bundles
- [`emulebb`](https://github.com/emulebb/emulebb): Stable 0.7.x Windows client, diagnostic baseline, and critical-fix maintenance lane.
- [`ed2k-server`](https://github.com/emulebb/ed2k-server): Sole local deterministic eD2K server, maintained as a minimal upstream-aligned Rust fork.
- [aMule upstream](https://github.com/amule-org/amule) (`master`): Actively developed upstream client used for analysis and future interoperability.
- [eMule stock 0.72](https://github.com/irwir/eMule) (`v0.72a`): Stock compatibility baseline for protocol and state-machine parity.

The MFC 0.7.3 release preserves the historical Suite installer and matching aMuTorrent artifact. Suite is a shipped bundle name, not an active cross-client roadmap.
</details>

## Start Here
## Keep in touch

- [Active beta downloads](https://github.com/emulebb/emulebb-rust/releases)
- [Stable maintenance downloads](https://github.com/emulebb/emulebb/releases/tag/emulebb-v0.7.3)
- [Read the public documentation](https://emulebb.github.io/emulebb-tooling/)
- [Review the eMuleBB Roadmap](https://github.com/orgs/emulebb/projects/3)
- [Open the organization website](https://emulebb.github.io/)
Expand Down