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
9 changes: 7 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ jobs:
"number=$($Matches[1])" >> $env:GITHUB_OUTPUT
- name: Test
run: dotnet test Waypoint.slnx -c Release
# Waypoint.exe carries DepotDownloader's release (the game client from Steam). The script holds it to its SHA-256,
# and fetches the source of that same release, which goes beside Waypoint.exe: it is GPL-2.0 (THIRD-PARTY-NOTICES.md).
- name: DepotDownloader
shell: pwsh
run: ./tools/Get-DepotDownloader.ps1 -Source
- name: Publish
shell: pwsh
run: |
Expand All @@ -49,6 +54,6 @@ jobs:
env:
GH_TOKEN: ${{ github.token }}
run: >
gh release create '${{ github.ref_name }}' out/Waypoint.exe out/Waypoint.exe.sha256
gh release create '${{ github.ref_name }}' out/Waypoint.exe out/Waypoint.exe.sha256 tools/bundled/DepotDownloader-3.4.0-source.zip
--title 'Waypoint ${{ steps.version.outputs.number }}' --generate-notes --verify-tag
--notes 'Download **Waypoint.exe** below and run it; a Waypoint you already have offers this version itself. The Source code archives are added by GitHub to every release and are not needed to run it.'
--notes 'Download **Waypoint.exe** below and run it; a Waypoint you already have offers this version itself. The Source code archives are added by GitHub to every release and are not needed to run it. Waypoint.exe carries DepotDownloader (GPL-2.0, THIRD-PARTY-NOTICES.md): its source is DepotDownloader-3.4.0-source.zip below.'
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# The published launcher (dotnet publish src/Waypoint -o .)
/Waypoint.exe

# What tools/Get-DepotDownloader.ps1 fetches for a build (Waypoint.exe carries it; it is never committed)
/tools/bundled/

# --- .NET ---
bin/
obj/
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ Launcher, and the setup, mod, backup, account, appearance and language tools of
It is a separate tool: it references no server project and drives a checkout only through what the server offers outside
tools (`scripts/dev/live.ps1`, the Gateway's `commands`/`values` modes, the dev host's protocol, the client control bridge,
the logs) and through its own adapter in `scripts/`. Every start goes through `live.ps1`, so the server's rules apply
unchanged. It does not download Path of Exile, bundle LocalExile or offer a public server.
unchanged. It does not bundle Path of Exile or LocalExile, and does not offer a public server.

## Install

Requirements: Windows 10/11 x64, the .NET 10 Desktop Runtime, and your own standalone PoE **3.29.3c** client (a player who has only 3.29.3b gets
Requirements: Windows 10/11 x64, the .NET 10 Desktop Runtime, and a PoE **3.29.3c** or **3.29.3d** client: your own standalone one, or for a release one Waypoint downloads from Steam
with your own Steam account ([The game client from Steam](docs/launcher.md#the-game-client-from-steam)) (a player who has only 3.29.3b gets
the last LocalExile made for it, see [Game client builds](docs/launcher.md#game-client-builds)). The setup guide
offers two ways to get LocalExile:

Expand All @@ -33,7 +34,7 @@ offers two ways to get LocalExile:
| [Git](https://git-scm.com/downloads/win) | Branches and pull requests |
| [Python 3.9+](https://www.python.org/downloads/windows/) | Data extraction, consistent save backups, the account tools. Tick the installer's *Add python.exe to PATH*; Waypoint also finds a Python installed without it |
| [Node.js](https://nodejs.org/en/download) | The bundle-decompression dependency |
| Your own standalone PoE **3.29.3c** client | A separate copy in the checkout's `Client` folder; Steam layout and other builds are unsupported |
| Your own standalone PoE **3.29.3c** or **3.29.3d** client | A separate copy in the checkout's `Client` folder; Steam layout and other builds are unsupported |

Frida (`pip install frida`) is optional: it is needed for walk maps, the console and live mod control, not for ordinary play.
The item crafter's Give item uses the Waypoint Tools mod instead, which it offers to install.
Expand All @@ -54,7 +55,7 @@ where they are. Neither old file is changed.

Linux has its own executable and interface (`src/Waypoint.Linux`, Avalonia) over the same engine, and the Windows app is
built as before. It needs the .NET 10 SDK, [umu-launcher](https://github.com/Open-Wine-Components/umu-launcher) and your own
standalone PoE **3.29.3c** client. A source checkout also needs PowerShell 7 (`dotnet tool install --global PowerShell`), Git,
standalone PoE **3.29.3c** or **3.29.3d** client. A source checkout also needs PowerShell 7 (`dotnet tool install --global PowerShell`), Git,
Python 3.9+ and Node.js.

```bash
Expand Down Expand Up @@ -134,6 +135,6 @@ dotnet publish src/Waypoint -o .
A build from source has no version and never offers updates. Everything else, from the sections to the code layout and
how a release is made, is in [docs/launcher.md](docs/launcher.md); what comes next is in [docs/roadmap.md](docs/roadmap.md).

Waypoint is under the [MIT license](LICENSE). OpenDyslexic is under the [SIL Open Font License](src/Waypoint/Fonts/OFL.txt).
Waypoint is under the [MIT license](LICENSE). What a released `Waypoint.exe` carries of others' work (DepotDownloader, GPL-2.0; OpenDyslexic, the [SIL Open Font License](src/Waypoint/Fonts/OFL.txt)) is in [THIRD-PARTY-NOTICES.md](THIRD-PARTY-NOTICES.md).

This project is not affiliated with or endorsed by Grinding Gear Games.
23 changes: 23 additions & 0 deletions THIRD-PARTY-NOTICES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Third-party notices

Waypoint is under the [MIT license](LICENSE). A released `Waypoint.exe` also carries the works below, each under its own
license. They are separate works: none of them changes Waypoint's license, and Waypoint's does not change theirs.

## DepotDownloader

- **What:** [DepotDownloader](https://github.com/SteamRE/DepotDownloader) 3.4.0, the program Waypoint runs to fetch a game
client from Steam ([docs/launcher.md](docs/launcher.md), "The game client from Steam").
- **How it is carried:** the project's own release for Windows x64 (`DepotDownloader-windows-x64.zip`, SHA-256
`41c9e9f0df54b3ad02e67a11726756e5c73283bd7c2e1b04acfa5ae4c2ed3767`), unchanged, inside `Waypoint.exe`. Waypoint unpacks it
into its own data folder (`tools\DepotDownloader`), with the `LICENSE` file that comes in that zip, and runs it as a
program of its own. Waypoint contains none of its code.
- **License:** GNU General Public License, version 2. Its full text is the `LICENSE` file beside the unpacked program, and
<https://github.com/SteamRE/DepotDownloader/blob/DepotDownloader_3.4.0/LICENSE>.
- **Source:** the corresponding source is the tag
[`DepotDownloader_3.4.0`](https://github.com/SteamRE/DepotDownloader/tree/DepotDownloader_3.4.0). Every Waypoint release
that carries the program has that source attached beside `Waypoint.exe`, as `DepotDownloader-3.4.0-source.zip`.
- DepotDownloader is built on SteamKit2 (LGPL-2.1), protobuf-net and QRCoder, whose notices are in its own repository.

## OpenDyslexic

The reading font Waypoint offers, under the [SIL Open Font License](src/Waypoint/Fonts/OFL.txt).
Loading
Loading