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: README.md
+27-36
Original file line number
Diff line number
Diff line change
@@ -6,52 +6,42 @@ your mining sites and warns you when they're starting to run low.
6
6
7
7
Once the mod is installed, using it is relatively simple:
8
8
9
-
* First, you must research the technology "Resource Monitoring". This enables
10
-
you to...
11
-
* Then, craft yourself a resource monitor. You should only ever need one, as it
12
-
does not get consumed.
13
-
* Walk over within build distance of an ore patch, take the resource monitor in
14
-
your hand, and tap it on the ore (click as if to place it).
9
+
* Use the shortcut button "Resource monitor marker" to drag-select at least one
10
+
ore entity in a patch (like using a blueprint).
15
11
* If everything went well, you should now see a blue overlay showing up on
16
-
top of the ore you clicked, and growing as YARM finds its neighbours, and
17
-
their neighbours, until the entire ore patch has been scanned.
18
-
* After the scan, you have 10 seconds to tap another ore of the same kind,
19
-
which will be added to the same site. This is currently the only way to add
20
-
disconnected ore patches to a single site.
12
+
top of the ore(s) you clicked, and growing as YARM finds their neighbours,
13
+
and their neighbours, until the entire ore patch has been scanned.
14
+
* After the scan, you have 2 seconds to select another ore of the same kind,
15
+
which will be added to the same site.
21
16
* If you tap the ground instead, you will cancel the site.
22
17
* If you tap a different kind of ore instead, you will instantly create
23
18
the site and start a new one on the other ore.
24
-
* Upon the expiry of those 10 seconds, the site will be created and a
19
+
* Upon the expiry of those 2 seconds, the site will be created and a
25
20
message will be shown informing you of its name and the amount of ore found
26
21
in it.
22
+
* Sites can be renamed at any time! The default name is just a
23
+
suggestion.
27
24
28
25
By default, YARM shows only sites that are about to expire (i.e., less than 10%
29
-
of their initial amount remaining). Clicking the single button shown in the
30
-
YARM interface switches it to "all sites" mode, where it will show every site
31
-
you've recorded.
26
+
of their initial amount remaining). There are buttons available to change the
27
+
filter to either "no sites" (which never shows any sites at all!) or "all
28
+
sites" (which never hides them).
32
29
33
30
Each site has some buttons associated with it:
34
31
35
-
* The 'eye' button allows you to remote-view the site from wherever you are in
36
-
the world. Click it again to return to your body.
37
-
* Note: it is possible (though unlikely) to get stuck in the remote viewer,
38
-
especially if entering it from a non-player entity (e.g., while using the
39
-
Fat Controller to view a train). This should normally be prevented, but if
40
-
somehow you end up in that state, you will need to find your character
41
-
entity, highlight it, and use the console command `/c remote.call("YARM",
42
-
"reset_player", game.player.name)`.
43
-
* The 'X' button (only shown while not viewing the site) allows you to delete
44
-
the site. When first clicked, it turns red; click it again within 10 seconds to
45
-
confirm deletion, or leave it alone to cancel it.
46
-
* The 'ab|' button (only shown while remote viewing the site) allows you to
47
-
rename the site. This can be useful to prevent auto-naming from overwriting one
48
-
of your sites with another. Names may not be longer than 50 characters!
49
-
* The '+' button (only shown while not viewing the site) allows you to expand
50
-
an existing site. Simply click the '+' for the site you want to expand, then
51
-
smack the resource monitor on the new ore site you want to add to the existing
52
-
monitor. Sites are not renamed by this process.
53
-
* NB: To prevent inconvenience, the '+' button will also drag a resource
54
-
monitor into your cursor, if you don't already have it there.
32
+
* The 'ab|' button allows you to rename the site. This can be useful to prevent
33
+
auto-naming from overwriting one of your sites with another.
34
+
* Note: Names may not be longer than 50 characters!
35
+
* The 'eye' button opens the map to the center of the ore, and zooms to world
36
+
if there is radar coverage.
37
+
* The 'X' button allows you to delete the site. When first clicked, it turns
38
+
red; click it again within 2 seconds to confirm deletion, or leave it alone to
39
+
cancel it.
40
+
* The '+' button allows you to expand an existing site. Click the '+' for the
41
+
site you want to expand, then use the marker tool to select the new ore site
42
+
you want to add to the existing monitor. Sites are not renamed by this process.
43
+
* NB: For ease of use, the '+' button also activates the resource
44
+
monitoring marker shortcut.
55
45
* Pressing the '+' while it's red (which indicates addition in progress)
56
46
will finish the adding process (and update the site, if it's changed).
57
47
* While expanding a site, a blue overlay (identical to the one used when
@@ -99,7 +89,8 @@ members of the #factorio IRC on espernet.
99
89
YARM's remote interface is grown as needed; there are only a few functions currently:
100
90
101
91
-`remote.call("YARM", "reset_player", player_name_or_index)`: sets the target player's character to be whatever the player has selected (if it's of a compatible type, of course) and clears out internal data relative to the player.
102
-
-`remote.call("YARM", "show_expando", player_name_or_index)` and the equivalent `"hide_expando"`: provides programmatic hooks to toggle the expando. Both return a boolean true if YARM was expandoed before the remote call, and false if it was not. This is an opportunity to return the expando to its previous setting after use.
92
+
-`remote.call("YARM", "reset_ui", player_name_or_index)`: destroys the target player's YARM UI, forcing it to be recreated (hopefully correctly) at the next UI update cycle (about every 5 seconds).
93
+
-`remote.call("YARM", "set_filter", player_name_or_index, new_filter)`: provides programmatic hooks to change the active filter. The filter value may be 'none', 'warnings', or 'all' -- other values are unsupported. The previously active filter is returned.
103
94
-`remote.call("YARM", "get_on_site_updated_event_id")`: returns the identifier for the `on_site_updated` event, detailed below. You should probably call this every time mods are initialized, as it is set in the main `control.lua` runtime.
0 commit comments