Skip to content

Clarified running instructions #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NastyFlytrap wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarified running instructions #243

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 17 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,27 @@ These scripts and support files from `OpenRAModSDK` wrap and automatically manag
and provide entrypoints to run development versions and to generate platform-specific installers.

Before running `d2 mod`, download the original game and copy the following files:
- `DUNE.PAK`
- `VOC.PAK`

- `ATRE.PAK`
- `DUNE.PAK`
- `FINALE.PAK`
- `HARK.PAK`
- `ORDOS.PAK`
- `INTRO.PAK`
- `FINALE.PAK`
- `ORDOS.PAK`
- `SCENARIO.PAK`
- `VOC.PAK`

For packaged installs(like this) or launchers that do not set a local support directory, the OpenRA platform support directory is used instead:
You can also place the files there if you run the mod through a registered OpenRA launcher instead of the SDK checkout launcher.

- `%USERPROFILE%\AppData\Roaming\OpenRA\Content\d2` (Windows)
- `%USERPROFILE%\AppData\Roaming\OpenRA\Content\d2k\v3` (Windows d2k content)
- `~/Library/Application Support/OpenRA/Content/d2` (macOS)
- `~/Library/Application Support/OpenRA/Content/d2k/v3` (macOS d2k content)
- `~/.openra/Content/d2` (Linux)
- `~/.openra/Content/d2k/v3` (Linux d2k content)

You can make it not save to %appdata% by creating a `Support` folder in d2-master\engine, and opening `launch-game.cmd`

When running from the SDK checkout, `launch-game.cmd` uses the local engine support directory.
Paste those files into:
Expand All @@ -30,16 +43,6 @@ On first run, `d2 mod` will open the content installer if the `d2k` files are mi
Use `Quick Install` to download the required `d2k` content and automatically return to `d2 mod`.
If you use `Advanced Install`, the installer may stay on the package list after downloading; press `Back`, then `Continue`, or close the game and run `launch-game.cmd` again.

For packaged installs or launchers that do not set a local support directory, the OpenRA platform support directory is used instead:
You can also place the files there if you run the mod through a registered OpenRA launcher instead of the SDK checkout launcher.

- `%USERPROFILE%\AppData\Roaming\OpenRA\Content\d2` (Windows)
- `%USERPROFILE%\AppData\Roaming\OpenRA\Content\d2k\v3` (Windows d2k content)
- `~/Library/Application Support/OpenRA/Content/d2` (macOS)
- `~/Library/Application Support/OpenRA/Content/d2k/v3` (macOS d2k content)
- `~/.openra/Content/d2` (Linux)
- `~/.openra/Content/d2k/v3` (Linux d2k content)

The key scripts from [OpenRAModSDK](https://github.com/OpenRA/OpenRAModSDK) are:

| Windows | Linux / macOS | Purpose
Expand Down