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
2 changes: 1 addition & 1 deletion .github/workflows/public-presence.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
with:
repository: emulebb/emulebb-tooling
ref: 027dcf32aab5ed2d1e3441b6231e8e500cc2e945
ref: 793e53a9514b61f91a115ba1684a74497ff3fe14
path: repos/emulebb-tooling
persist-credentials: false

Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ local deltas only.

## Hard Rules

- The org profile is **text-first**, with the operator-approved proposal-1 Rust
- The org profile is **text-first**, with the operator-approved proposal-5 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.
Expand Down
99 changes: 75 additions & 24 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,63 @@
<!-- 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)
[![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)

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

eMuleBB Rust is an eD2K/Kad client for Windows, Linux and macOS, operated through a browser console and authenticated REST API.
<p align="center">
<img src="https://emulebb.github.io/assets/brand/emulebb-logo-256.png" width="160" height="160" alt="eMuleBB Rust pixel donkey identity" />
</p>

<h1 align="center">eMuleBB</h1>
<p align="center">
<strong>eD2K &middot; Kad &middot; Rust</strong><br />
eMuleBB Rust is an eD2K/Kad client for Windows, Linux and macOS, operated through a browser console and authenticated REST API.
</p>

<p align="center">
<a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-GETTING-STARTED/"><strong>Use eMuleBB Rust</strong></a> &nbsp;&middot;&nbsp;
<a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-CONTRIBUTING/"><strong>Develop with eMuleBB Rust</strong></a>
</p>
<p align="center">
<a href="https://github.com/emulebb/emulebb-rust/releases">Nightly downloads</a> &middot;
<a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-DOWNLOADS-PLATFORMS/">Platforms</a> &middot;
<a href="https://emulebb.github.io/emulebb-tooling/">Documentation</a> &middot;
<a href="https://github.com/orgs/emulebb/projects/3">Roadmap</a>
</p>
<p align="center">
<a href="https://github.com/emulebb/emulebb-rust/actions/workflows/ci.yml"><img src="https://github.com/emulebb/emulebb-rust/actions/workflows/ci.yml/badge.svg?branch=main" alt="Rust CI" /></a>
<a href="https://github.com/emulebb/emulebb-tooling/actions/workflows/docs-site.yml"><img src="https://github.com/emulebb/emulebb-tooling/actions/workflows/docs-site.yml/badge.svg?branch=main" alt="Documentation build" /></a>
</p>

**Active beta.** CI-gated nightly builds are the public testing channel. Beta 3 is the next development target.

## Use or develop
---

| 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/) |
## Use or develop

- **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.
<table>
<tr>
<td width="50%" valign="top">
<h3>Use eMuleBB Rust</h3>
<p>Choose your package, start the daemon and open the browser console.</p>
<a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-DOWNLOADS-PLATFORMS/">Choose a platform</a> &middot; <a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-GETTING-STARTED/">First launch</a>
</td>
<td width="50%" valign="top">
<h3>Develop with eMuleBB Rust</h3>
<p>Build the client, improve the WebUI or connect an integration.</p>
<a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-CONTRIBUTING/">Contributor guide</a> &middot; <a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/api/GUIDE-API-CONSUMERS/">REST API</a>
</td>
</tr>
</table>

## What you can do

<table>
<tr>
<td width="50%" valign="top"><h3>Browser console</h3><p>Search eD2K/Kad, manage transfers and monitor chosen shared folders.</p></td>
<td width="50%" valign="top"><h3>REST automation</h3><p>Use authenticated requests and a documented API contract.</p></td>
</tr>
<tr>
<td width="50%" valign="top"><h3>Network controls</h3><p>Review interfaces, connection status and diagnostics.</p></td>
<td width="50%" valign="top"><h3>Identifiable builds</h3><p>Inspect source-bound manifests, checksums and provenance.</p></td>
</tr>
</table>

See the platform guide for package checks, network-validation scope and the limits of the published proof.

Expand All @@ -31,12 +66,28 @@ See the platform guide for package checks, network-validation scope and the limi

## Work across the project

| Repository | Role |
| --- | --- |
| [`emulebb-rust`](https://github.com/emulebb/emulebb-rust) | Active Rust beta and current product-development lane. |
| [`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. |
<table>
<tr>
<td width="50%" valign="top">
<h3><a href="https://github.com/emulebb/emulebb-rust">emulebb-rust</a></h3>
<p>Active Rust beta and current product-development lane.</p>
</td>
<td width="50%" valign="top">
<h3><a href="https://github.com/emulebb/emulebb-tooling">emulebb-tooling</a></h3>
<p>Public roadmap, lifecycle policy, product docs, and engineering references.</p>
</td>
</tr>
<tr>
<td width="50%" valign="top">
<h3><a href="https://github.com/emulebb/emulebb-build">emulebb-build</a></h3>
<p>Workspace, build, validation, packaging, and release orchestration.</p>
</td>
<td width="50%" valign="top">
<h3><a href="https://github.com/emulebb/emulebb-build-tests">emulebb-build-tests</a></h3>
<p>Shared Rust and MFC diagnostics, compatibility, live-network, and parity harness.</p>
</td>
</tr>
</table>

## Maintenance and references

Expand Down