BSC
Wiki
Browse all pages
BSC Wiki home
Getting startedBark School CorgoDeveloping GuideEditing the wikiFAQIronman ModeRules
BSC contentBest In SlotCreatablesCustom ItemsCustom MonstersGetting StartedItem ContractsLeagues
AreasPolypore DungeonThe Verdant Island
Clue ScrollsElder CluesGrandmaster Clues
Custom ItemsAxe of the High SungodCapesDyesImplingsPetsSkilling outfits
MinigamesBalthazar's Big BonanzaBaxtorian BathhousesDivine DominionEmerged Zuk InfernoFishing ContestFist of GuthixGuthixian CacheInfernoMarimbo's Monkey RumbleOurania Delivery Service (ODS)Shades of Mort'tonStealing CreationTinkering WorkshopTurael's Trials
MiscellaneousDouble LootHoliday EventsUse command
MonstersAkumuCelestaraChambers of Xeric (CoX)Depths of AtlantisIgnecarusKalphite KingKing GoldemarMalygosMoktangNaxxusNexNihilizQueen Black DragonRaidsSea KrakenSolisTheatre of Blood (ToB)Tombs of Amascut (ToA)TreebeardVasa MagusVenatrixVladimir Drakan
SkillsAgilityCombat SkillsConstructionCookingCraftingDivinationDungeoneeringFarmingFiremakingFishingFletchingHerbloreHunterInventionMiningPrayerRunecraftSlayerSlayer Masks / HelmsSmithingThievingWoodcutting
TamesEagle TameIgneMonkey TameTames
Core gameClue ScrollsCombat AchievementsCreatablesMonstersQuests
ActivitiesAerial FishingBrimhaven Agility ArenaDrift Net FishingFountain of RuneGuardians of the RiftHallowed SepulchreMage Training ArenaMahogany HomesMotherlode MineShooting StarsTemporossVolcanic MineWintertodt
BossesColosseumFight CavesInfernoNexThe NightmareWilderness
BuyablesBuyable Items and Shop Pricing MechanicsBuyablesTrip Buyables
Getting StartedAdvanced ResourcesBank BackgroundsBank FiltersBeginner GuideCombat TrainingGearGrand Exchange
MinigamesBarbarian AssaultBig Chompy Bird HuntingCamdozaalCreature CreationGauntletGnome RestaurantLast Man StandingPest ControlShades Of Mort'tonSoul WarsTemple TrekkingTrouble BrewingVale TotemsWarriors Guild
MiscellaneousAchievement DiariesBingoChampions ChallengeCharging ItemsCollectingCrack The ClueGod CapesHall of FameMinion IconsMusic CapeNightmare ZoneOfferingReverting ItemsTears of GuthixZalcano
RaidsChambers of Xeric (CoX)Theatre of Blood (ToB)Tombs of Amascut (ToA)
SkillsAgilityAuto FarmingBirdhousesBlast FurnaceConstructionCookingCraftingCrystal ImplingsFarmablesFarmingFarming ContractsFarming TrainingFiremakingFishingFletchingForestryGiant's FoundryHerbiboarHerbloreHunterHunter TrainingMagic (Non-combat)MiningMisc Info & FAQPassive ImplingsPlayer-owned HousesPrayerPuro PuroPyramid PlunderRogues DenRunecraftingSlayerSlayer BoostsSmithingStash UnitsThievingTithe FarmUnderwater TrainingWildy SlayerWoodcuttingWoodcutting Training

Developing Guide

Getting started · Updated 2026-11-16 by Zootr
Help improve this pageHistory

Bark School Corgo is open to contributions. If you want to fix a bug or add something new, this page walks you through getting set up and getting your change into the bot.

Getting access

The bot's code lives in a private repository. To get access, ask DJ or Zootr on the BSC Discord. They can also add your test bot to the shared testing server, which is where changes get tried out before they reach the real bot.

Setting up

You'll need your own test bot to run the code locally.

  1. Make a test bot. Create an application in the Discord Developer Portal. Save its Application ID and Token, and turn on Server Members Intent under Privileged Gateway Intents.
  2. Install the tools. You need Node.js (use the version the repository asks for), pnpm, and PostgreSQL. Visual Studio Code is recommended.
  3. Get the code. Once you have access, clone the repository.
  4. Configure it. Make a .env.test file from the example file in the repository, then fill in your test bot's Application ID (CLIENT_ID), Token (BOT_TOKEN) and your database details.
  5. Install and build. Run these in order:
    • pnpm install
    • pnpm build:packages
    • pnpm gen
    • pnpm db:push:test
  6. Start your bot with pnpm start:test.

The SETUP.md file in the repository has more detail if you get stuck.

Useful commands

Command What it does
pnpm start:test Runs your test bot.
pnpm build:packages Builds the shared packages (like oldschooljs). Run it after changing one, or if you see strange type errors.
pnpm gen Regenerates the database clients after a schema change.
pnpm lint Checks and formats your code.
pnpm test:unit Runs the unit tests.
pnpm test:integration Runs the integration tests (needs a test database).
pnpm dev Does most of the above in one go. Handy before you open a pull request.

Making a change

  1. Make a new branch for every change. Never work on the main branch.
  2. Keep it focused. One feature or fix per pull request is much easier to review.
  3. Check your work before opening the pull request:
    • the type check passes
    • the unit tests pass
    • you've tried it on your test bot
  4. Go through the anti-exploit checklist in docs/anti-exploit-checklist.md. Anything that gives items, takes items, costs GP or sets a price needs it, for example quantity checks, removing items before giving new ones, and shop price rules.
  5. Open a pull request using the template: a short description, a list of changes, the anti-exploit checklist results, your checks, and anyone who helped test it.

Every pull request gets a quality check from DJ or Zootr before it goes live.

Things that are easy to miss

  • New database tables need adding to the wipe plan, so they're handled properly when a season is reset.
  • New slash commands need adding to the command name list in the database, or their usage won't be logged.
  • Custom item icons go in src/lib/resources/images/bso_icons, named after the item's ID. Run pnpm spritesheet to rebuild the icon sheet.

Need help?

Ask on the BSC Discord, and someone will point you in the right direction. If you've found a bug but don't want to fix it yourself, report it here.