Skip to content
Oldschool.gg Wiki

Developing Guide

Important Tips

  • I use this link 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 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.