Skip to content

Commit 27c0d8a

Browse files
committed
update readme
1 parent c119ec3 commit 27c0d8a

4 files changed

Lines changed: 36 additions & 10 deletions

File tree

README.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,48 @@
1-
# Copilot
2-
Shows the next thing you should click.
1+
<p align="center">
2+
<img src="./img/logo.png"><br>
3+
<h1 align="center">Copilot</h1>
4+
</p>
5+
6+
Shows the next thing you should click.
7+
Every single step is highlighted, so you can mindlessly grind whilst doing something else.
38

49
# Demo
510
https://user-images.githubusercontent.com/115373370/195444530-a0a17efc-7d8c-4574-b306-4a7f7c64e578.mp4
611

712
# Supported activities
8-
* Woodcutting - Willow - Draynor Village
9-
* Woodcutting - Yew - Woodcutting Guild
10-
* Fishing & Cooking - Trout & Salmon - Barbarian Village
13+
## Woodcutting
14+
General purpose for chopping trees and banking the logs.
15+
* select a tree and log type by clicking it
16+
17+
### Crafting
18+
General purpose for bankstanding skills.
19+
* enter your tool, for example: knife, glassblowing pipe
20+
* enter your resource, for example: yew logs, molten glass
21+
* enter your product, for example: yew longbow(u), lantern lens
22+
23+
### Fishing & Cooking
24+
Fishing trout and salmon at Barbarian Village, and cooking it.
25+
26+
### General inactivity alert
27+
For unsupported activities.
28+
Alerts you when you have not yet animated, moved or clicked something for set time.
29+
Works for a lot of things, but does not show you what to click.
1130

1231
# Features
1332
Configuration options:
14-
![Settings configuration](/img/settings.png "Copilot configuration options.")
15-
33+
![Settings configuration](/img/settings.png "Copilot configuration options.")
34+
Some configuration options further explained:
35+
* Alert delay: after how many milliseconds of inactivity you are alerted.
36+
* Alert sound ID: the sound played when you are alerted.
37+
You can choose from the [Sound IDs wiki page](https://oldschool.runescape.wiki/w/List_of_in-game_sound_IDs).
38+
* Alt alert sound ID: the sound played when you are alerted and your inventory is full.
39+
* Amount of alerts: the amount of alerts that sound when you are inactive.
40+
You could for example set a single very loud alert, or 1000 soft ticks to keep reminding you to interact with the game.
1641

17-
# Ideas
18-
* Different sounds for banking vs afking
42+
# Tips
43+
* Use the menu entry swapper plugin to make every action left-clickable.
44+
* Use the camera plugin to zoom out more and enable vertical camera.
1945

20-
# Coming
46+
# Planned features
2147
* Tempoross
2248
* Giant's Foundry

img/logo.png

1.33 MB
Loading

img/settings.png

868 Bytes
Loading

img/settings1.png

6.88 KB
Loading

0 commit comments

Comments
 (0)