You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-10Lines changed: 17 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,9 +66,10 @@ The easiest way to make and test changes is by setting up a development installa
66
66
67
67
cd PathOfBuilding-PoE2
68
68
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.
72
73
73
74
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:
74
75
*`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
97
98
--end
98
99
```
99
100
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.
101
102
102
103
The manifest.xml file deserves its own in depth document, but usually copying from release and editing accordingly works well enough.
103
104
@@ -205,7 +206,7 @@ Files in `/Data` `/Export` and `/TreeData` can be massive and cause the EmmyLua
205
206
206
207
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.
207
208
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.
@@ -226,9 +227,15 @@ More tests can be added to this folder to test specific functionality, or new te
226
227
Please try to include tests for your new features in your pull request. Additionally, if your pr breaks a test that should be passing please update it accordingly.
227
228
228
229
### Debugging tests
229
-
When running tests with a docker container it is possible to use EmmyLua for debugging. Follow the instructions for inserting the debugger snippet as shown above in [Visual Studio Code](#Visual-Studio-Code), then uncomment the `dbg.waitIDE()` line.
230
-
231
-
After running `docker-compose up` the code will wait at that line until a debugger is attached. This will allow stepping through any code that is internal to POB but will not work for busted related code. Note that this only works for unit tests described above.
230
+
When running tests with a docker container it is possible to use EmmyLua for debugging. Paste in the following right under `function launch:OnInit()` in `./src/Launch.lua`:
-- This port must match the IDE Code configuration. Default is 9966.
235
+
dbg.tcpListen("localhost", 9966)
236
+
dbg.waitIDE()
237
+
```
238
+
After running `docker-compose up` the code will wait at the `dbg.waitIDE()` line until a debugger is attached. This will allow stepping through any code that is internal to POB but will not work for busted related code. Note that this only works for unit tests described above.
232
239
233
240
## Path of Building development tutorials
234
241
@@ -260,9 +267,9 @@ as well as some familiarity with build tools such as [CMake](https://cmake.org).
260
267
261
268
### Set up the exporter
262
269
1. Copy `bun_extract_file.exe`, `libbun.dll` and `libooz.dll` to `.\src\Export\ggpk\`.
263
-
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:
264
271
265
-
"<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"
266
273
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.
267
274
4. Click `Edit Sources...` to display the "New DAT Source" popup. Click `New` and enter a name.
268
275
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