Skip to content

Commit 75bae0d

Browse files
authored
docs: clarify Linux launch instructions (PathOfBuildingCommunity#1822)
1 parent 6d79e6c commit 75bae0d

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,10 @@ The easiest way to make and test changes is by setting up a development installa
6666

6767
cd PathOfBuilding-PoE2
6868

69-
3. Start Path of Building from the repository by running `./runtime/Path{space}of{space}Building-PoE2.exe`.
70-
71-
* <ins>Note for Linux users:</ins> The executable files should automatically have the correct permissions when cloned fresh. If you still encounter permission issues, run once: `chmod +x ./runtime/Path{space}of{space}Building-PoE2.exe`
69+
3. Start Path of Building from the repository.
70+
* On Windows, run `./runtime/Path{space}of{space}Building-PoE2.exe`
71+
* On Linux, run `wine ./runtime/Path{space}of{space}Building-PoE2.exe`
72+
* <ins>Note for Linux users:</ins> `chmod +x` only fixes the execute bit. The file is still a Windows executable, so Wine is required to run it.
7273

7374
You can now use the shortcut to run the program from the repository. Running the program in this manner automatically enables "Dev Mode", which has some handy debugging feature:
7475
* `F5` restarts the program in-place (this is what usually happens when an update is applied).
@@ -97,7 +98,7 @@ To do so [comment out Line 54 to line 58](./src/Launch.lua#L54-L58) of the [Laun
9798
--end
9899
```
99100

100-
and create a valid manifest.xml file in the ./src directory. Then run the `./runtime/Path{space}of{space}Building.exe` as usual. You should get the typical update popup in the bottom left corner.
101+
and create a valid manifest.xml file in the ./src directory. Then run the `./runtime/Path{space}of{space}Building-PoE2.exe` as usual. You should get the typical update popup in the bottom left corner.
101102

102103
The manifest.xml file deserves its own in depth document, but usually copying from release and editing accordingly works well enough.
103104

@@ -205,7 +206,7 @@ Files in `/Data` `/Export` and `/TreeData` can be massive and cause the EmmyLua
205206

206207
If you're on windows, consider downloading [git for windows](https://git-scm.com/downloads) and installing git bash. Git bash comes with a variety of typical linux tools such as grep that can make navigating the code base much easier.
207208

208-
If you're using linux you can run the ./runtime/Path{space}of{space}Building.exe executable with wine. You will need to provide a valid wine path to the emmy lua debugger directory.
209+
If you're using linux you can run the `./runtime/Path{space}of{space}Building-PoE2.exe` executable with wine. You will need to provide a valid wine path to the emmy lua debugger directory.
209210

210211
```bash
211212
# winepath -w ~/.vscode/extensions/tangzx.emmylua-0.8.20-linux-x64/debugger/emmy/windows/x64/
@@ -266,9 +267,9 @@ as well as some familiarity with build tools such as [CMake](https://cmake.org).
266267

267268
### Set up the exporter
268269
1. Copy `bun_extract_file.exe`, `libbun.dll` and `libooz.dll` to `.\src\Export\ggpk\`.
269-
2. Create a shortcut to `.\runtime\Path{space}of{space}Building.exe` with the path to `.\src\Export\Launch.lua` as the first argument. You should end up with something like:
270+
2. Create a shortcut to `.\runtime\Path{space}of{space}Building-PoE2.exe` with the path to `.\src\Export\Launch.lua` as the first argument. You should end up with something like:
270271

271-
"<path to repo>\runtime\Path{space}of{space}Building.exe" "<path to repo>\src\Export\Launch.lua"
272+
"<path to repo>\runtime\Path{space}of{space}Building-PoE2.exe" "<path to repo>\src\Export\Launch.lua"
272273
3. Run the shortcut. "Dat View", the GGPK data viewer UI, should appear. If you get an error, be sure you're using the latest release of Path of Building Community.
273274
4. Click `Edit Sources...` to display the "New DAT Source" popup. Click `New` and enter a name.
274275
5. Paste the full path to `Content.ggpk` into the "Source from GGPK/Steam PoE path" box and hit `Enter`. For the stand-alone client, the path must include the file-name. (Do not put anything in the "Source from DAT files" box unless you have already manually unpacked the relevant files.)

0 commit comments

Comments
 (0)