Change/format step by step

main
Alt 2 years ago committed by GitHub
parent be966faf36
commit 0fb8bbecb9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,50 +1,59 @@
## Step by step guide to setting up `node.js to Bitburner connection`, for dummies
# Step by step guide to setting up the Typescript template from scratch
This guide is mostly focused on Windows users (Mac instructions are given at some places).
If you're a Linux/Mac/Other user, there's an expectancy that you know your system and it's peculiarities compared to Windows.
If you need help with your particular system, feel free to ask for help in the Official Bitburner Discord.
### 1. Backup your savegame
### 1. Backup your savegame (just in case)
- Augmentations -> Backup save
### 2. Install node.js from https://nodejs.org/en/
### 2. Install Node.js
- Go to https://nodejs.org/en/
- Download the version that's recommended for most users.
- Install it. Just click next, next, next, next, finish.
### 3. Download this:
https://github.com/bitburner-official/typescript-template
- Click the green code button -> download zip
- Extract the zip anywhere, for example `c:\node\`
### 3. Download this:
- Go to https://github.com/bitburner-official/typescript-template
- Click the green 'Code' button
- If you're unfamiliar with Git and have no intention to use it:
- Press the Download Zip button
- Extract the zip anywhere, for example `C:\Users\yourusername\Workspace\BitburnerScripts` on Windows or `~/Workspace/BitburnerScripts` on Other
### 4. Download this:
https://raw.githubusercontent.com/danielyxie/bitburner/dev/src/ScriptEditor/NetscriptDefinitions.d.ts
- Press ctrl+s, save this into same directory you just created, for example `c:\node\`
### 5. Run the node server --------is it called a server?---------
### 4. Start the Remote File API server
- Open command prompt / terminal
- Windows: Open start menu and type `cmd` (enter)
- Mac: --------check if this is correct!--------- Click the Launchpad icon in the Dock, type `Terminal` in the search field, then click Terminal.
- Mac: Click the Launchpad icon in the Dock, type `Terminal` in the search field, then click Terminal.
- To go to the directory you just created:
- Windows: type `cd ` and drag the folder you created to the cmd window, or type `cd c:\node` or whatever folder you chose previously.
- Mac: --------check if this is correct! and the cd command twice--------- drag the folder you created to the terminal window, or type `cd \node` or whatever folder you chose previously.
- type `npm install typescript`
- Windows: Type `cd ` and drag the folder you created to the cmd window, or type `cd C:\Users\yourusername\Workspace\BitburnerScripts` or whatever folder you chose previously.
- Mac: Type `cd ` drag the folder you created to the terminal window, or type `cd ~/Workspace/BitburnerScripts` or whatever folder you chose previously.
- type `npm install`
- type `npm run watch`
- If the npm asks if you want to install something it needs, answer `y` for yes.
- If NPM asks if you want to install something it needs, answer `y` for yes.
- Your firewall may yell at you; allow the connection.
### 6. Go back to Bitburner.
- Options -> remote api -> type in the port: `12525` -> click connect. The icon should turn green and say it's online.
### 5. Go back to Bitburner.
- Options -> Remote API -> type in the port: `12525` -> click connect. The icon should turn green and say it's online.
- Your firewall may yell at you again; allow the connection.
### 7. That's it!
- You should see a file `template.js` in the root of your `home` server in Bitbuner.
### 8. Test that the connection works
- Copy/create a .js and a .txt file to `c:\node\dist\` directory - or whatever directory you chose in step 3 - on your computer and check Bitburner. The file should be transferred.
### 9. If you want to use typescript
### 6. Starting the Typescript transpiler
- DON'T SKIP EVEN WHEN USING JS ONLY
- Open another cmd/terminal window just like you did in step 4.
- This time run the command `npm run transpile`. Yes, you need them both to be running at the same time.
- This time run the command `npm run transpile` in your folder.
Yes, you need them both to be running at the same time.
- Put your .ts files to the `src\` directory.
### 7. Test that the connection works
- You should see a file `template.js` in the root of your `home` server in Bitburner.
- You should see a NetscriptDefinitions.d.ts automatically appear in the `src` folder on your computer.
### 8. Try some other files too!
- Copy/create a .js and a .txt file to the `src` directory on your computer and check Bitburner. The files should be transferred!
### 10. Thats it! Again.
- Edit the file `template.ts` in the `src\` directory and check that the contents of the file `template.js` in Bitburner are changed to match your edit.
<br>
<br>
### For more information, read the readme of this https://github.com/bitburner-official/typescript-template and feel free to ask in Bitburner Discord channel `#external-editors:` https://discord.com/channels/415207508303544321/923428435618058311
### 9. Thats it!
- You can now make and edit the files in the `src` directory to your liking, and have them be changed in Bitburner automatically.
<br />
<br />
### For more information
Read the readme of this https://github.com/bitburner-official/typescript-template and feel free to ask in Bitburner Discord channel `#external-editors:` https://discord.com/channels/415207508303544321/923428435618058311

Loading…
Cancel
Save