Skip to content

Commit 95ded69

Browse files
committed
fix: restore previous instructions for OnlineTools + fix images links
1 parent f5a131c commit 95ded69

File tree

2 files changed

+31
-10
lines changed

2 files changed

+31
-10
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,33 @@ A TUI (Terminal User Interface) application for managing [Peacock](https://thepe
4141

4242
## Connecting to Peacock
4343

44-
After installing the ZHMModSDK via the launcher, start the game and:
44+
Start the game and open the SDK panel with the `~` key (`^` on QWERTZ layouts or `²` on AZERTY layouts), click the `Mods` button in the top left, find `OnlineTools` and check the box next to it, finally press `OK`.
4545

46-
1. Open the SDK panel with the `` ` `` key (`` ^ `` on QWERTZ layouts or `²` on AZERTY layouts)
47-
2. Click **Mods** → enable **OnlineTools** → click **OK**
48-
3. Open the SDK panel again → click **OnlineTools**
49-
4. Change the server address to `localhost:3000` and press Enter
46+
Next, open the SDK panel again. There should be a new `OnlineTools` button on the bar at the top of the screen, click this button and the following menu should appear;
47+
48+
![Default OnlineTools Menu](.github/readme-img/onlinetools_default_menu.png)
49+
50+
Then, press the `Help` button, give the menu that pops up a read to familiarise yourself with the mod. Then press `Load Old Patcher Settings` and close the help popup.
51+
52+
The main OnlineTools window should now look like this;
53+
54+
![OnlineTools Old Patcher Settings](.github/readme-img/onlinetools_old_patcher_settings.png)
55+
56+
If you have not changed the port from the default of `3000`, you need to change the `localhost` line to `localhost:3000` then press enter.
57+
58+
If you are using port `80` you do not need to change this. If you changed it to something other than `3000`, you need to change it to `localhost:PORT` where `PORT` is your chosen port.
59+
60+
The window should now look like this (if you are using the default configuration);
61+
62+
![OnlineTools With Changed Port](.github/readme-img/onlinetools_changed_port.png)
63+
64+
If you want to choose when you connect to Peacock, you can open the OnlineTools menu and press the circled button below;
65+
66+
![OnlineTools Apply Domain](.github/readme-img/onlinetools_apply_button.png)
67+
68+
If you want to connect to Peacock every time you start the game, you can check the box highlighted below;
69+
70+
![OnlineTools Default Domain](.github/readme-img/onlinetools_default_domain.png)
5071

5172
See the [ZHMModSDK install guide](https://github.com/OrfeasZ/ZHMModSDK/blob/master/INSTALL-deck.md) for more details.
5273

legacy/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,29 +139,29 @@ Start the game and open the SDK panel with the `~` key (`^` on QWERTZ layouts),
139139

140140
Next, open the SDK panel again. There should be a new `OnlineTools` button on the bar at the top of the screen, click this button and the following menu should appear;
141141

142-
![Default OnlineTools Menu](.github/readme-img/onlinetools_default_menu.png)
142+
![Default OnlineTools Menu](../.github/readme-img/onlinetools_default_menu.png)
143143

144144
Then, press the `Help` button, give the menu that pops up a read to familiarise yourself with the mod. Then press `Load Old Patcher Settings` and close the help popup.
145145

146146
The main OnlineTools window should now look like this;
147147

148-
![OnlineTools Old Patcher Settings](.github/readme-img/onlinetools_old_patcher_settings.png)
148+
![OnlineTools Old Patcher Settings](../.github/readme-img/onlinetools_old_patcher_settings.png)
149149

150150
If you have not changed the port from the default of `3000`, you need to change the `localhost` line to `localhost:3000` then press enter.
151151

152152
If you are using port `80` you do not need to change this. If you changed it to something other than `3000`, you need to change it to `localhost:PORT` where `PORT` is your chosen port.
153153

154154
The window should now look like this (if you are using the default configuration);
155155

156-
![OnlineTools With Changed Port](.github/readme-img/onlinetools_changed_port.png)
156+
![OnlineTools With Changed Port](../.github/readme-img/onlinetools_changed_port.png)
157157

158158
If you want to choose when you connect to Peacock, you can open the OnlineTools menu and press the circled button below;
159159

160-
![OnlineTools Apply Domain](.github/readme-img/onlinetools_apply_button.png)
160+
![OnlineTools Apply Domain](../.github/readme-img/onlinetools_apply_button.png)
161161

162162
If you want to connect to Peacock every time you start the game, you can check the box highlighted below;
163163

164-
![OnlineTools Default Domain](.github/readme-img/onlinetools_default_domain.png)
164+
![OnlineTools Default Domain](../.github/readme-img/onlinetools_default_domain.png)
165165

166166
# Troubleshooting
167167

0 commit comments

Comments
 (0)