Skip to content

Commit

Permalink
Test updates; VS Code configuration; further trimming
Browse files Browse the repository at this point in the history
  • Loading branch information
mammerla committed Dec 14, 2023
1 parent 33a1789 commit 38459bb
Show file tree
Hide file tree
Showing 89 changed files with 854 additions and 6,670 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ dist/
node_modules/
app/public/data/typedefs.beta.json
app/public/data/typedefs.stable.json
app/public/res/latest/van/
app/public/res/latest/
/~$
app/nod
# misc
Expand Down
43 changes: 9 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,30 @@
# Minecraft Creator Tools v0.1.49
# Minecraft Creator Tools v0.1.63

Web-, command-line-, and application-based tools for Minecraft creators.
This is project is a work in progress for a set of web-based tools for Minecraft Creators.

Visit the [documentation](https://silver-guide-3a7f4789.pages.github.io/docs/) for more information on everything you can do with Minecraft Creator Tools.
Visit the [documentation](https://mctools.dev/docs/) for more information on Minecraft Creator Tools and the current set of capabilities.

See the [changelog](CHANGELOG.md) for detailed updates and notes. If you have issues, contact mikeam or create a [GitHub issue](https://github.com/Mojang/minecraft-developer-tools/issues).
See the [changelog](CHANGELOG.md) for detailed updates and notes. If you have issues, please create a [GitHub issue](https://github.com/Mojang/minecraft-creator-tools/issues).

See the [Project Structure](ProjectStructure.md) file for a look at the structure of the codebase including a tour of major types.

## Using Creator Tools

Visit this web app via <https://aka.ms/mctools>.

(this app is published to GitHub pages (<https://silver-guide-3a7f4789.pages.github.io/>), but <https://aka.ms/mctools> works better.

To use the Windows application, Visual Studio Code extension, command line tools, or server manager, visit the [releases](https://github.com/Mojang/minecraft-developer-tools/releases) page.
Visit this web app via <https://mctools.dev>.

Enjoy!

## GitHub Repo & Developer Getting Started

Most everything (Windows App; VSCode Extension; web site; Node.js-based command line tools) is built out of the `web` folder.
Everything is built out of the `app` folder.

In the `app\` folder, run

```dotnetcli
buildall.cmd
```

This will then in turn run:

```dotnetcli
npm i
npm run all
```

to install dependencies.

Then, it will run:

```dotnetcli
npm run devenv
```

This will install additional dependencies and resources.

From there, it will build the web, JS Node (JSN), Visual Studio Code (VSC), and Windows app builds.
to install dependencies and resources.

## Available Scripts

Expand All @@ -53,7 +33,7 @@ In the project directory, you can run:
### `npm start` \ `npm run web`

Runs the app in the development mode.
Open [http://localhost:3000?debug=true](http://localhost:3000?debug=true) to view it in the browser.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

**_ IMPORTANT - note the extra URL params above. _**

Expand All @@ -72,8 +52,3 @@ See the section about [running tests](https://facebook.github.io/create-react-ap
Builds the web app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

### `npm run jsnbuild`

Builds the node package/command line tool/self-hostable Minecraft server site to the `toolbuild\jsn` folder. Run `npm run jsncorebuild` for a shorter build of just the Node-side components (no UX web build.)

5 changes: 5 additions & 0 deletions app/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"esbenp.prettier-vscode"
]
}
27 changes: 27 additions & 0 deletions app/.vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"version": "0.2.0",
"configurations": [
{
"type": "pwa-chrome",
"request": "launch",
"name": "Launch Chrome against localhost",
"url": "http://localhost:3000",
"webRoot": "${workspaceFolder}"
},
{
"type": "node",
"request": "launch",
"name": "Mocha tests",
"program": "${workspaceFolder}/node_modules/ts-mocha/bin/ts-mocha",
"preLaunchTask": "gulp: jsncorebuild",
"args": [
"-p", "tsconfig.test.json",
"-delay",
"--no-timeouts",
"--colors",
"${workspaceFolder}/src/test/**/*.ts"
],
"internalConsoleOptions": "openOnSessionStart"
}
]
}
Loading

0 comments on commit 38459bb

Please sign in to comment.