Skip to content

Commit

Permalink
Merge branch 'master' into alabastorosb
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkWorldsArtist authored Oct 29, 2024
2 parents b145581 + 053d477 commit 504e679
Show file tree
Hide file tree
Showing 14 changed files with 76 additions and 108 deletions.
32 changes: 32 additions & 0 deletions docs/src/content/docs/getting-started/developing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Developing Guide"
sidebar:
order: 9999
lastUpdated: 2024-10-01T03:41:00.552Z
---

### Important Tips

- I use [this link](https://github.com/oldschoolgg/oldschoolbot/pulls?q=is%3Aopen+is%3Apr+-label%3A%22Status%3A+Waiting+For+Changes%22+-label%3A%22Status%3A+Needs+Information%22++-label%3A%22Status%3A+WIP%22+) when reviewing PRs, if your PR has certain labels (like 'Waiting for changes', or 'Status:WP'), it will be excluded from my reviewing list, so update the labels of your PR as appropriate.
- Run `yarn dev` before pushing commits to a PR, it will do everything you need (linting, building, testing, etc).
- You need a test bot, and have it added to our testing server, and it's highly encouraged you do your testing there.
- If you have any question or need help, ask in `#developers`, and you're welcome to ping @magnaboy.

### Commands

`yarn dev`: Run this before pushing/PRing, or just at any time if you want, it does almost everything you need: Update deps, generate prisma clients, build, update files, lint and test.

`yarn watch`: Starts/runs your bot, and restarts it when you make changes.

`yarn lint`: Run this if you only want to lint your code, and nothing else. (yarn dev runs this)

`yarn test`: Run this if you only want to test your code, and nothing else (yarn dev runs this)

### Spritesheet

The spritesheet is a big image file containing most icons the bot uses for items, not all items are in it, if the bot need any that aren't in it, it will download them on demand.

- To update the spritesheet, use `yarn spritesheet`. This will only have an effect if something has actually changed.
- If new osrs items are being added, you first need to download [the new cache](https://github.com/runelite/static.runelite.net/archive/refs/heads/gh-pages.zip) and extract it so `/cache/item/icon` is in `tmp/icons` in the repo.
- Must only be run on the master (osb) branch.
- If new BSO items are added, the images should be put in the master branch in `src/lib/resources/images/bso_icons`, and the item names/ids in the `bso_items.json` file.
2 changes: 2 additions & 0 deletions docs/src/content/docs/getting-started/wiki.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,8 @@ This is an automatically generated list of pages with possible issues to be look

[/getting-started/changelog.md](https://github.com/oldschoolgg/oldschoolbot/blob/master/docs/src/content/docs/getting-started/changelog.md): Doesnt use the new command formatting

[/getting-started/developing.md](https://github.com/oldschoolgg/oldschoolbot/blob/master/docs/src/content/docs/getting-started/developing.md): Doesnt use the new command formatting

[/getting-started/FAQ.md](https://github.com/oldschoolgg/oldschoolbot/blob/master/docs/src/content/docs/getting-started/FAQ.md): Doesnt use the new command formatting

[/getting-started/hackertoberfest.mdx](https://github.com/oldschoolgg/oldschoolbot/blob/master/docs/src/content/docs/getting-started/hackertoberfest.mdx): Doesnt use the new command formatting
Expand Down
25 changes: 6 additions & 19 deletions docs/src/content/docs/osb/Bosses/inferno.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: "Inferno"
---

## Summary

The Inferno is a very high level PVM activity. It has high gear requirements, consumes large amounts of expensive supplies, and attempts can take upwards of 2 hours.

Similar to the Fight Caves, you are not guaranteed to complete The Inferno. Your success chance scales on your gear, number of attempts, and number of Zuk fights.
Expand All @@ -18,17 +16,15 @@ Tokkul can be spent at the [Tokkul shop](https://wiki.oldschool.gg/bosses/fight-

To begin a trip into the inferno, use:

- `/activities infernoaction: ``Start Inferno Trip`
- `/activities inferno action:Start Inferno Trip`

To view information on your previous attempts/KCs, use:

- `/activities infernoaction: ``Check Inferno Stats`
- `/activities inferno action:Check Inferno Stats`

To gamble a cape for a chance at the Jal-nib-rek pet, use:

- `/gamble capetype: ``infernal`

---
- `/gamble cape type:infernal`

## Requirements

Expand All @@ -52,8 +48,6 @@ Twisted bow or Armadyl crossbow with ammo based on the weapon you're using (arro

Runes for Ice barrage + Blood barrage (200 casts of blood barrage/hour and 100 casts of ice barrage/hour. Rune costs are reduced by having a Kodai wand equipped in your mage setup.)

---

## Boosts

Boosts for the Inferno are split into two categories: speed and death chance. Speed boosts decrease the time required to complete the Inferno, and death chance boosts decrease your odds of dying before or during the Zuk fight.
Expand Down Expand Up @@ -82,15 +76,8 @@ Equipping an Elysian spirit shield in either range or mage (-5%)

Equipping a Ring of suffering (i) in either range or mage (-4%)

Equipping a Justiciar faceguard in range (-5%) \
Equipping a Twisted bow in your range setup (instead of an ACB) (1.5% from Tbow VS 7.5% with ACB)
Equipping a Justiciar faceguard in range (-5%)

The number of attempts you've done, and the number of times you've fought Zuk greatly affect speed and death chance.
Equipping a Twisted bow in your range setup (instead of an ACB) (1.5% from Tbow VS 7.5% with ACB)

---

## Gear

<figure><figcaption></figcaption></figure>

Using this gear, along with dragon darts in your blowpipe, will give the maximum bonus for Inferno.
The number of attempts you've done, and the number of times you've fought Zuk greatly affect speed and death chance.
6 changes: 2 additions & 4 deletions docs/src/content/docs/osb/Skills/fishing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
title: "Fishing"
---

# Fishing
You can train Fishing using `/fish name:<fish> quantity:<quantity>`, for example `/fish name:Lobster quantity:100`

You can train Fishing using `/fishname:<fish>quantity:<quantity>`, for example `/fishname:Lobsterquantity:100`

Fishing bait is buyable with `/buyname: ``Fishing bait`.
Fishing bait is buyable with `/buy name:Fishing bait`.

Dark fishing bait and Raw Karambwanji aren't sold by the bot and can only be obtained by buying from other players or obtaining them yourself.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,31 @@ Blood runes and Soul runes can be crafted at the Dark Altar using [[/runecraft]]
- 20% faster essence mining for Kourend Medium diary.
- -20% penalty if you have no Graceful equipped.
- -35% penalty if you have less than 73 Agility.

## Fastest Route to 99:

`/runecraft rune:Air Rune quantity:103` (until level 6) \
`/runecraft rune:Mist Rune quantity:76` (until level 10) \
`/runecraft rune:Dust Rune quantity:75` (until level 13) \
`/runecraft rune:Mud Rune quantity:61` (until level 15) \
`/runecraft rune:Smoke Rune quantity:164` (until level 19) \
`/runecraft rune:Steam Rune quantity:232` (until level 23) \
`/runecraft rune:Lava Rune` (repeat until 99)

**Materials Needed:** 1,241,520 Pure essence and 1000-2000 Binding necklaces \
1,240,800 Earth rune, 293 Water rune and 315 Air rune. Abyssal sire drops Binding necklaces in quantity's of 25. This assumes you have a staff providing infinite fire runes in your skilling setup.
**For each lap of Lava runes:** 1 Earth talisman or 2 Astral rune + 7 Fire rune + 7 Water rune for Magic Imbue (lvl 82 magic), 1-2 charges Ring of dueling(8) and sometimes a dose of Stamina potion(4) is consumed.

### Alternative Route to 99 (more profitable):

`/runecraft rune:Air Rune quantity:17`\
`/runecraft rune:Mind Rune quantity:56`\
`/runecraft rune:Water Rune quantity:97`\
`/runecraft rune:Earth Rune quantity:176`\
`/runecraft rune:Fire Rune quantity:338`\
`/runecraft rune:Body Rune quantity:4368`\
`/runecraft rune:Astral Rune` - to 77\
`/runecraft rune:Blood Rune` - to 90 (or 99)\
`/runecraft rune:Soul Rune` - to whatever, this is best xp/hr at the Dark altar!

**Materials needed:** 170,382 pure essence

This file was deleted.

2 changes: 1 addition & 1 deletion docs/src/content/docs/osb/Skills/smithing/blast-furnace.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Blast Furnace"
---

The Blast Furnace can be used with the \*\*`blast_furnace:true` option in the `/smelt` command. For example `/smelt name:Gold bar blastfurnace:true`
The Blast Furnace can be used with the `blast_furnace:true` option in the `/smelt` command. For example `/smelt name:Gold bar blastfurnace:true`

The Blast Furnace costs 216,000 gp/hr to use, or 72,000 gp/hr if your minion is an ironman.

Expand Down
4 changes: 1 addition & 3 deletions docs/src/content/docs/osb/Skills/smithing/giants-foundry.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Look no further for amazing smithing xp and a use for those stacked up bars! You

To start a trip of Giant's Foundry, use:

- `/minigames giants_foundry startname: ``[alloyType]`
- `/minigames giants_foundry start name:[alloyType]`

## Requirements

Expand Down Expand Up @@ -43,8 +43,6 @@ If you run the following command, you will see your overall foundry stats.

- `/minigames giants_foundry stats`

<figure><figcaption></figcaption></figure>

Here you will see your total unique weapons made. There are 1,331 possible weapons to create, with each weapon having an equal chance to be created. The type of alloy does not affect the chances of which weapon will be made. This means that using lower tier bars is considerably more cost effective if you're wanting to collect all unique weapons. There is no CL for these weapons, it's purely just a statistic.

## XP/Hour
Expand Down
6 changes: 3 additions & 3 deletions docs/src/content/docs/osb/Skills/woodcutting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Woodcutting"
---

You can train Woodcutting using `/chopname:[logs]`. If no quantity is specified, it will default to a full trip. Using the powerchop option will result in no logs being obtained, but provides significantly faster woodcutting xp rates.
You can train Woodcutting using `/chop name:[logs]`. If no quantity is specified, it will default to a full trip. Using the powerchop option will result in no logs being obtained, but provides significantly faster woodcutting xp rates.

- `/chopname:Willow logsquantity:50`
- `/chopname:Teak logspowerchop:true`
- `/chop name:Willow logs quantity:50`
- `/chop name:Teak logs powerchop:true`

## Axes

Expand Down
4 changes: 0 additions & 4 deletions docs/src/content/docs/osb/Skills/woodcutting/forestry.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,11 @@ This minigame is conducted passively while completing _almost any_ woodcutting t

- There are no requirements for this activity

---

## Boosts

- Regular woodcutting [axe boosts](./#axes)
- 20% boost to Bird nests from [Twitcher's gloves](forestry.md#twitchers-gloves)

---

## Forestry Events

There are 9 forestry events. Each one has an equal chance to spawn. The chance of a forestry event spawning is 1/20 for every minute of your trip (average of 1 event per 20 mins). Some events will give common items, bonus xp, or a unique CL item. All events will give between 250-500 Anima-infused bark.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"dev": "yarn dev:stage1 && yarn dev:stage2 && yarn dev:stage3 && yarn dev:stage4",
"watch:tsc": "tsc -w -p src",
"buildandrun": "yarn build:esbuild && node --enable-source-maps dist",
"start": "echo 'yarn start is now the same as yarn watch' && yarn watch",
"start": "yarn watch",
"============SCRIPTS": "============",
"spritesheet": "tsx ./scripts/spritesheet.ts && yarn lint:biome",
"data": "concurrently \"tsx ./scripts/monster_table.ts\" && yarn lint",
Expand Down
40 changes: 0 additions & 40 deletions scripts/downloadcache.ts

This file was deleted.

0 comments on commit 504e679

Please sign in to comment.