Skip to content
Open
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
58 changes: 0 additions & 58 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ jobs:
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v4

# This is needed to be able to run ./gradlew below
# You can run `git update-index --chmod +x gradlew` then remove this step.
- name: Make Gradle wrapper executable
run: chmod +x ./gradlew

Expand All @@ -41,62 +39,6 @@ jobs:
python -m pip install -r tools/requirements.txt

- name: Verify release build
libs/*)
module="root"
;;
*/core/echocore/build/libs/*)
module="core/echocore"
;;
*/addons/*/build/libs/*)
module="${jar#*/addons/}"
module="addons/${module%%/*}"
;;
esac

target_name="${module//\//__}__$(basename "$jar")"
cp "$jar" "dist/jars/$target_name"
printf '%s\t%s\t%s\n' "$module" "$(basename "$jar")" "$target_name" >> dist/jars/manifest.tsv
done

- name: Upload JAR artifacts
uses: actions/upload-artifact@v4
with:
name: echo-jars-${{ github.sha }}
path: dist/jars/*.jar
if-no-files-found: error
retention-days: 21

- name: Summarize built JARs
run: |
set -euo pipefail
{
echo "## Runtime JAR Artifacts"
echo
echo "| Module | JAR |"
echo "| --- | --- |"
while IFS=$'\t' read -r module source_jar target_jar; do
echo "| ${module} | ${source_jar} (`${target_jar}`) |"
done < dist/jars/manifest.tsv
} >> "$GITHUB_STEP_SUMMARY"
=======
run: ./gradlew verifyEchoRelease validateReleaseArtifacts -x checkEchoModJarSet

- name: Generate release manifest
run: ./gradlew printReleaseManifest > release-manifest.txt

- name: Upload release manifest artifact
uses: actions/upload-artifact@v4
with:
name: release-manifest
path: release-manifest.txt

- name: Upload release assets
if: startsWith(github.ref, 'refs/tags/v')
uses: softprops/action-gh-release@v2
with:
files: |
release-manifest.txt
- name: Verify release build
run: ./gradlew verifyEchoRelease -x checkEchoModJarSet

- name: Collect built JAR artifacts
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ Addons communicate through `echocore` and `echoterminal` instead of reaching int
7. Wake the Nexus campaign, scan six Prime Relays, resolve three relays, survive the Core countermeasure siege, then restore enough grid infrastructure to reach the Nexus Core and choose Restore, Destroy, or Control.
8. Use FIELD > Reclamation to recover seeds and stabilize a small food route, then use ORBITAL / Orbital Command to begin the post-Nexus quarantine expansion and surface the Stationfall, Nexus, Industrial, and Blackbox chapter entries from the shared terminal.


## GitHub Wiki Publishing

The `wiki/` folder in this repo is the source-of-truth for wiki pages, but GitHub serves wiki content from the separate `Echo.wiki.git` repository.

If the Wiki tab still shows “Create the first page”, publish the files in `wiki/` into `https://github.com/knoxhack/Echo.wiki.git`.

See `docs/wiki_publish.md` and `tools/sync_wiki.sh` for the exact workflow.

## Requirements

- Minecraft 26.1.2
Expand Down
31 changes: 31 additions & 0 deletions docs/wiki_publish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Publishing the GitHub Wiki

The `wiki/` directory in this repository is a **source folder** only.
GitHub Wiki content is stored in a separate Git repository at:

- `https://github.com/<owner>/<repo>.wiki.git`

For this repository, that is:

- `https://github.com/knoxhack/Echo.wiki.git`

## One-time bootstrap

```bash
git clone https://github.com/knoxhack/Echo.wiki.git /tmp/Echo.wiki
cp -f wiki/*.md /tmp/Echo.wiki/
cd /tmp/Echo.wiki
git add .
git commit -m "docs: bootstrap wiki pages"
git push origin master
```

## Ongoing sync

Use the helper script from repo root:

```bash
bash tools/sync_wiki.sh /path/to/local/Echo.wiki
```

Then commit and push from the wiki repo.
24 changes: 24 additions & 0 deletions tools/sync_wiki.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/usr/bin/env bash
set -euo pipefail

if [ "$#" -ne 1 ]; then
echo "Usage: $0 /path/to/Echo.wiki"
exit 1
fi

wiki_repo="$1"

if [ ! -d "$wiki_repo/.git" ]; then
echo "Target is not a git repository: $wiki_repo"
exit 1
fi

mkdir -p "$wiki_repo"
cp -f wiki/*.md "$wiki_repo/"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Mirror wiki deletions when syncing

The helper is documented as an ongoing wiki sync tool, but this copy step only adds or overwrites files and never removes markdown pages that were deleted or renamed in wiki/. In that scenario, stale pages remain in Echo.wiki and continue to be published, so the wiki can drift from the repo source-of-truth over time. Consider using a delete-aware sync (for example rsync --delete or an explicit cleanup pass) so removals are propagated.

Useful? React with 👍 / 👎.


echo "Copied wiki/*.md to $wiki_repo"
echo "Next steps:"
echo " cd $wiki_repo"
echo " git add ."
echo " git commit -m 'docs: sync wiki content'"
echo " git push origin master"
23 changes: 23 additions & 0 deletions wiki/Addon-Development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Addon Development

## Integration Rules

1. Integrate via `echocore` public services.
2. Register terminal navigation through `echoterminal` public profile APIs.
3. Keep chapter logic, persistence, and reward authority inside the owning addon.
4. Avoid direct mutation of another chapter's save domain.

## Recommended Addon Skeleton

- Module metadata and Gradle wiring
- Chapter-owned progression state
- Worldgen/content registrations
- Terminal navigation registration
- Optional recipe provider registration
- GameTests / validation hooks

## Compatibility Philosophy

- Be tolerant of missing optional addons.
- Fail gracefully on duplicate registration attempts.
- Preserve forward compatibility by relying on contract types, not internals.
24 changes: 24 additions & 0 deletions wiki/Architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Architecture

## Layer Model

- **`echocore` (service layer):** shared profile state, faction data, route records, diagnostics, rewards, and cross-module contracts.
- **`echoterminal` (presentation layer):** shared terminal surfaces and navigation profile routing.
- **Campaign addons (domain layer):** chapter-specific gameplay, progression, worldgen, entities, and rewards.

## Integration Contracts

### Echo Core

Addons should publish and consume shared data through `echocore` service interfaces rather than direct save-data coupling.

### Echo Terminal

Navigation is registered via terminal profile types (for owned chapter surfaces), and recipe-aware modules can register recipe providers for shared indexing/search.

## Why This Design

- Reduces brittle cross-addon dependencies
- Keeps chapters independently shippable
- Preserves a consistent terminal UX across the full stack
- Enables progressive chapter expansion without rewriting the base campaign
33 changes: 33 additions & 0 deletions wiki/Build-and-Release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Build and Release

## Build Entire Workspace

```powershell
.\gradlew.bat buildEchoWorkspace
```

## Run Full Verification Gate

```powershell
.\gradlew.bat verifyEchoRelease --warning-mode all
```

## Copy Built Jars to Modpack Profile

```powershell
.\gradlew.bat copyEchoJarsToModpack
```

## Additional Validation

```powershell
python -m pip install -r tools\requirements.txt
python tools\validate_resources.py
python tools\validate_gameplay_data.py
```

## Version Contract

- Tags follow `v<major>.<minor>.<patch>` (optional prerelease suffix).
- Tag version must match module release versions for that cut.
- Release title should mirror the exact tag.
22 changes: 22 additions & 0 deletions wiki/Getting-Started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Getting Started

## First World Flow (Ashfall Entry)

1. Spawn in the compact drop pod and collect starter supplies from pod lockers.
2. Establish first-night shelter, clean water, and a basic weapon.
3. Follow ECHO terminal prompts for survival and machine progression.
4. Build your early chain: Hand Recycler → Micro Generator → Filter Workbench → Water Purifier → Battery Bank.
5. Use scanner intel and route planning to safely expand into POIs and guardian progress.

## Recommended New-Player Loop

- Keep hydration and filter state stable before long expeditions.
- Treat dirty water as emergency-only.
- Read route hazard reports before committing to deeper nodes.
- Use terminal pages (What Now, Mission Graph, Vitals, Route Records) to avoid dead-ends.

## Progression Arc

- **Ashfall** introduces survival, faction pressure, power, and Nexus access.
- **Orbital Remnants** continues post-Nexus route consequences.
- **Further chapters** (Stationfall, Nexus Protocol, Industrial Nexus, Blackbox Protocol) expand story and systems through shared APIs.
39 changes: 39 additions & 0 deletions wiki/Home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# ECHO Mod Stack Wiki

Welcome to the official documentation hub for the **ECHO mod stack ecosystem**.

ECHO is a modular NeoForge experience built around a shared runtime (`echocore`) and a shared UI layer (`echoterminal`), with campaign chapters delivered as interoperable addons.

## Quick Navigation

- [[Getting Started]]
- [[Architecture]]
- [[Modules and Versions]]
- [[Progression Guide]]
- [[Addon Development]]
- [[Build and Release]]
- [[Troubleshooting]]
- [[Lore and World Canon]]

## What is the “Ecosystem”?

The ECHO ecosystem includes:

1. **Core runtime services** (`echocore`)
2. **Terminal UX shell and shared surfaces** (`echoterminal`)
3. **Main campaign module** (`echoashfallprotocol`)
4. **Expansion chapters/addons** (Orbital, Stationfall, Nexus, Industrial, Blackbox, and more)
5. **Tooling and release workflow** used to validate and ship the full stack

## Supported Baseline

- Minecraft `26.1.2`
- NeoForge `26.1.2.29-beta`+
- Java `25+`

## Stack Principles

- **Shared state through contracts:** addons integrate through public `echocore` APIs.
- **Chapter ownership:** each addon owns its own progression, rewards, and persistence.
- **Terminal as shell:** `echoterminal` routes and presents data; it does not own chapter logic.
- **Composable world narrative:** each chapter extends the route without hard dependencies on private internals of other modules.
14 changes: 14 additions & 0 deletions wiki/Lore-and-World-Canon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Lore and World Canon

ECHO’s tone blends tactical survival operations with eerie post-collapse mystery.

## Canon Guidance

- Operational clarity first: player always has a next actionable objective.
- Atmosphere supports gameplay: lore should reinforce route pressure, hazard context, and faction motives.
- Chapters build continuity: each addon extends shared world state and route consequences.

## References

- `LORE_BIBLE.md` for writing guardrails
- chapter mission/archives data for localized canon beats
24 changes: 24 additions & 0 deletions wiki/Modules-and-Versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Modules and Versions

## Public Stack

| Module | Version | Role |
|---|---:|---|
| `echocore` | `1.1.0` | Shared service contracts and persistence surfaces |
| `echoterminal` | `1.1.0` | Shared terminal shell and route UI |
| `echoashfallprotocol` | `1.3.0` | Main campaign and entry progression |
| `echoorbitalremnants` | `1.5.0` | Post-Nexus orbital continuation |
| `echoagriculturereclamation` | `0.1.0` | Ecology and food-route recovery chapter |
| `echostationfall` | `1.1.0` | Station horror/progression chapter |
| `echonexusprotocol` | `1.0.0` | Nexus corruption and escalation chapter |
| `echoindustrialnexus` | `0.1.0` | Industrial automation/recovery chapter |
| `echoblackboxprotocol` | `1.0.0` | Late-game blackbox finale chapter |

## Workspace Module Sets

The build can target a **beta-only** addon set or **all** addons by `echoAddonSet`.

- `beta`: core + beta addon list
- `all`: beta + release addon list

See root `settings.gradle` for authoritative inclusion logic.
19 changes: 19 additions & 0 deletions wiki/Progression-Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Progression Guide

## Canonical Route (High Level)

1. **Podfall survival** and baseline crafting
2. **Machine and filter stabilization**
3. **POI scouting and route risk management**
4. **Guardian / relay escalation**
5. **Nexus confrontation and final branch choice**
6. **Post-Nexus chapter expansion** through Orbital and downstream addons

## Important Systems to Track

- Hydration and contamination
- Radiation and mutations
- Toxic air / filter load
- Power and machine throughput
- Faction standing and contract impacts
- Route records and mission graph checkpoints
29 changes: 29 additions & 0 deletions wiki/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Troubleshooting

## Common Issues

### Missing or mismatched jars

Run the copy task and ensure only one current jar exists per module in the modpack profile.

### Release verification failures

- Re-run resource and gameplay validators.
- Confirm all required modules for your chosen addon set are present.
- Run with `--warning-mode all` for better diagnostics.

### Old world behavior drift

Legacy worlds may require new chunk generation to surface current POI/resource distribution updates.

## Bug Report Template

```text
Version / mod list:
World age and seed:
What you expected:
What happened:
Steps to reproduce:
Screenshots or crash report:
Coordinates / biome / POI:
```
Loading