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
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ Never commit game source files, archives, meshes, textures, credentials, interme

Maintainers review the final diff and CI results before merging. Dataset changes also receive a review report for the exact PR commit. Keep unrelated changes out of the PR and resolve review feedback before merge.

For changes to datasets, deployment tools or their workflows, maintainers must
dispatch `Dataset review (trusted)` from `main` and wait for its successful result
on the exact PR head and base before merging. Ordinary CI does not replace this
review. A changed head or base needs a fresh review. Contributors provide prepared
packages through their own published source releases; they do not need server
credentials or permission to publish canonical releases.

## Licensing contributions

Submit original code and documentation under the same
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ pnpm dev

Open `http://127.0.0.1:5173`. The downloader restores all five maps, approximately 2.8 GB of ready tiles, from the immutable product release selected by `config/dataset-releases.lock.json`. It uses the Python standard library; no Git LFS, game installation, Docker, or OpenMW is needed. `pnpm dev` does not download missing maps.

The repository is currently private. Authenticate with an existing `gh auth login` session or provide `GH_TOKEN` / `GITHUB_TOKEN` in the environment with repository Contents read access. Do not put tokens in commands or files. If the repository becomes public, `pnpm datasets:download --anonymous` works without credentials or `gh`. Downloads verify hashes, reuse complete maps and cached archives, and can safely be retried; `--discard-cache` removes verified archives after extraction to save disk space.
Public releases can be downloaded without a GitHub account, token, or `gh`: use `pnpm datasets:download --anonymous` to explicitly disable credential lookup. Downloads verify hashes, reuse complete maps and cached archives, and can safely be retried; `--discard-cache` removes verified archives after extraction to save disk space.

For a private repository or private source release, authenticate with an existing `gh auth login` session or provide `GH_TOKEN` / `GITHUB_TOKEN` in the environment with repository Contents read access. Anonymous access works only when the source repository and release are public. Do not put tokens in commands or files.

## Build

Expand Down
3 changes: 2 additions & 1 deletion docs/DATASET_CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ pnpm datasets:download

Python 3.10+ on macOS or Linux is sufficient; the downloader uses the standard
library. It also works from a source ZIP without Git, Docker, or game inputs.
The repository is currently private. The downloader reads `GH_TOKEN` /
Public source releases support downloads without a GitHub account. For private
source repositories, the downloader reads `GH_TOKEN` /
`GITHUB_TOKEN` from the environment or an existing `gh auth login` session. A fine-grained token needs only
repository Contents read access. Public releases support `--anonymous`, which
does not read credentials or require `gh`. Never put tokens in command arguments.
Expand Down