osrs-cli 2.0.1

Command line utility program for Old School RuneScape
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# [osrs-cli](https://osrs.lucaspickering.me)

[![Test Status](https://github.com/LucasPickering/osrs-cli/actions/workflows/test.yml/badge.svg)](https://github.com/LucasPickering/osrs-cli/actions/workflows/test.yml)
[![crates.io version](https://img.shields.io/crates/v/osrs-cli.svg)](https://crates.io/crates/osrs-cli)

A command line tool for doing lookups and calculations related to Oldschool RuneScape. Features include:

- Calculate drop rate
- Calculate XP to a level
- Hiscores lookups
- And more!

This tool is intended for people who are already familiar and comfortable with the command line. If you aren't, then you're probably better off using the wiki and other web-based tools.

## Installation

[See the website](https://osrs.lucaspickering.me/install)

## Examples

Here are some simple examples. For more detail, see the [user guide on the website](https://osrs.lucaspickering.me/guide).

### Hiscore lookup

```
osrs hiscore <username>
```

### Calculate drop rate

```
> osrs calc drop --probability 1/5000 --kills 1000
18.1286% chance of ≥1 successes in 1000 attempts
```

#### Calculate XP to a level

```
osrs calc xp --from-xp 100000 --to-lvl 80
osrs calc xp --from-lvl 50 --to-lvl 60
```

### Calculate spicy stew boosts

```
> osrs calc stew --doses 25 --boost 3

+------------+-------+-------+-------+-------+-------+
| Doses/Stew |   ≥+1 |   ≥+2 |   ≥+3 |   ≥+4 |   ≥+5 |
+------------+-------+-------+-------+-------+-------+
|          1 | 99.9% |  0.0% |  0.0% |  0.0% |  0.0% |
|          2 | 99.6% | 96.8% | 79.9% |  0.0% |  0.0% |
|          3 | 98.7% | 96.1% | 90.0% | 76.8% | 50.0% |
+------------+-------+-------+-------+-------+-------+
```

### Search the wiki

```
osrs wiki shark
osrs wiki smithing
```

### Ping a world

```
osrs ping 450
```

## Bug Reports/Feature Requests

Found a bug or have a suggestion for a new feature? [Submit an issue on this repo](https://github.com/LucasPickering/osrs-cli/issues/new).

## Development

Interested in contributing? Here's some basic steps for setup:

### CLI

The CLI is written entirely in Rust.

Required tools:

- [rustup](https://rustup.rs/)
- [mise](https://mise.jdx.dev/installing-mise.html)

```sh
cargo run -- help # Run any command
cargo test # Run unit tests
```

### Website

The website is HTML/CSS, compiled using the 11ty framework.

```sh
cd website
mise run start
```

Change files and you should see the site refresh in your browser.