Skip to content

TUTORIAL: Text and UI changes - #3079

Open
branchtheory wants to merge 88 commits into
bitburner-official:devfrom
branchtheory:docs-content
Open

TUTORIAL: Text and UI changes#3079
branchtheory wants to merge 88 commits into
bitburner-official:devfrom
branchtheory:docs-content

Conversation

@branchtheory

@branchtheory branchtheory commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

This is ready for review!

To get a feel for what's changed, I'd recommend going through the current tutorial first.

You can try the new version at https://a-branch-of-branch.github.io/bitburner-src/.

What I've added

The 2 additional steps are:

  • checking script RAM cost in the Script Editor
  • scp-ing our hack script

And there are 3 new bits of information:

  • the bit about Tech centres in the World step (adapted from the "you can buy extra ram on home" bit in the original)
  • these two lines in the Script Editor step:
    • "When using scripts to hack, you don't need to be connected to the target server. Scripts can target any server, no matter where you are."
    • "Almost everything we do in this tutorial can be scripted using functions available to you right away."

Despite that, the new version is 331 words / 21% shorter (1262 words compared to 1593).

What I've removed

  • Hacknet
  • A lot of wordiness

Less obvious changes

All the changes should be visible on the surface just from doing the tutorial, with the exception of these, which only appear circumstantially:

  • Flashing the Script Editor tab without incrementing the step. In the current code, if you flash a sidebar item, the associated useEffect increments the tutorial step. The new incrementTutorialStep variable lets you choose whether or not to increment. So now we flash the Script Editor tab to help you get back to it if, for example, you follow the API documentation links.
  • The changes to error messages when interacting with the Terminal incorrectly (wrong command, wrong step etc.).
  • The change to the dialogue message you get when you save a different version of the code to the one from the tutorial.

Refactoring

Tried to do this all in the other PR but missed some things:

  • I've done a refactor of the switch statement in Terminal.ts. The flow is now way clearer and it should be easier to review.
  • I've added an isRunning check to SidebarRoot.
  • I've changed references to "n00dles.js" to tutorialScriptName where possible.

One irrelevant change

There's one irrelevant change -- to src/Sidebar/ui/SidebarAccordion.tsx -- which was collateral from running npm run format. Not intended but I can't seem to get rid of it.

@branchtheory
branchtheory marked this pull request as ready for review September 7, 2026 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants