Skip to content
This repository has been archived by the owner on Nov 11, 2022. It is now read-only.

Commit

Permalink
rewrite
Browse files Browse the repository at this point in the history
  • Loading branch information
GTB3NW committed Sep 3, 2021
1 parent 19c6417 commit 0caa417
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,26 @@

This project is aimed to get you started with the GameTest framework.

Pre-requisites:
## Pre-requisites

- [x] - Minecraft Bedrock Edition 🤦
- [x] - npm - [NodeJS Install Guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and-npm)
- [x] - VSCode - [Download](https://code.visualstudio.com/Download)
- Minecraft Bedrock Edition 🤦
- npm - [NodeJS Install Guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and-npm)
- VSCode - [Download](https://code.visualstudio.com/Download)

## Steps

Follow these steps to start using the project.

- [ ] - Rename `example-pack.code-workspace` to your own project name, eg. `my-pack.code-workspace`
- [ ] - Open the renamed `<yourprojectname>.code-workspace` file in VSCode, `File > Open Workspace`
- [ ] - Update the header fields in `manifest.json`
- [ ] - `header.description`
- [ ] - `header.name`
- [ ] - `header.uuid` - [Use a generator](https://www.uuidgenerator.net/)
- [ ] - Update the `modules` section in `manifest.json`
- [ ] - `modules[0].description`
- [ ] - `modules[0].uuid` - [Use a generator](https://www.uuidgenerator.net/)
- [ ] - Update the project name and description in `package.json`
- [ ] - Run `npm install` at the apex (root folder) of the project, you should see `node_modules` created
- [ ] - Run `npm run build`, you should see `scripts/main.js` created
- [Use the template](https://github.com/Bedrock-OSS/gametest-starter-project/generate)
- Clone your repository
- Install prettifier, `ctrl+p` and run `ext install esbenp.prettier-vscode`
- Update the header fields in `manifest.json`
- `header.description`
- `header.name`
- `header.uuid` - [Use a generator](https://www.uuidgenerator.net/)
- Update the `modules` section in `manifest.json`
- `modules[0].description`
- `modules[0].uuid` - [Use a generator](https://www.uuidgenerator.net/)
- Update the project name and description in `package.json`
- Run `npm install` at the apex (root folder) of the project, you should see `node_modules` created
- Run `npm run build`, you should see `scripts/main.js` created

0 comments on commit 0caa417

Please sign in to comment.