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 CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Issues, bug reports, map corrections, and focused pull requests are welcome. Des

## Make a change

1. Follow the setup in [README.md](README.md).
1. Check the [platform and tool requirements](README.md#requirements), then follow the local setup in README. Use Linux or macOS; native Windows build support is still in development.
2. Create a branch from current `main`, for example `fix/search-retry` or `feature/place-filter`.
3. Make a focused change. Use English for application copy, documentation, commit messages, and PR text. Preserve upstream names and intentional Unicode data.
4. Run checks relevant to the change, then open a PR into `main`. Explain the result and how you checked it.
Expand Down
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,27 @@ Five interactive maps for The Elder Scrolls III: Morrowind, available at [morrow

Search places, filter locations, share map links, and keep progress, notes, and personal markers. Mod titles in the map header link to their Nexus Mods pages in a new tab. Personal data stays in your browser; use JSON export/import to transfer it or keep a backup. Records are associated with a specific map version.

## Requirements

Local development, dataset preparation, and builds currently require a Unix-like
environment: Linux or macOS with a POSIX-compatible shell. CI runs on Linux.

- Node.js `^20.19.0` or `>=22.12.0` (CI uses Node.js 24).
- pnpm `11.19.0`.
- Python 3.10+ available as `python3` in the same shell as `node` and `pnpm`.
- Network access for dependencies and map archives, plus disk space for about
2.8 GB of extracted maps, downloaded archives, and a separate production build.

**Native Windows build support is in development and is not currently available.**
The commands below assume a Unix environment; the dataset tools use Unix-only
Python file locking (`fcntl`). Installing Git Bash alone does not provide this
Python support. These restrictions apply to local tooling; the hosted website
can be used from a Windows browser.

## Run locally

Install Node.js `^20.19.0` or `>=22.12.0`, pnpm `11.19.0`, and Python 3.10+. From your clone or extracted source ZIP:
After installing the requirements above, run these commands from your clone or
extracted source ZIP:

```bash
pnpm install --frozen-lockfile
Expand Down
5 changes: 5 additions & 0 deletions docs/RENDERING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ it does not modify the website or the tracked active dataset.

## Prerequisites

Use Linux or macOS with the Unix shell and tool versions listed in the
[project requirements](../README.md#requirements). Native Windows build and
rendering support is still in development; Docker alone does not make the host
Python tools compatible with Windows.

Follow [README.md](../README.md) to install dependencies and run `pnpm datasets:download` to restore all five active maps from their pinned product release. Candidates preserve all active maps, so a single-map rerender also needs the other maps' prepared baselines. Install Chromium for candidate browser checks:

```bash
Expand Down