Fascinated/Minetrack
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update MIGRATING.md

Browse Source
This commit is contained in:
Nick Krecklow 2020-04-23 21:22:53 -05:00 committed by GitHub
parent 0ad4025472
commit 359ca61ea1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/MIGRATING.md
View File

@ -4,15 +4,16 @@ Minetrack 5 is the first of several upcoming updates designed to address several
## Upgrading Minetrack 5 ## Upgrading Minetrack 5
1. Stop any running instance of Minetrack. 1. Stop any running instance of Minetrack.
2. If you've cloned the repository, use `git clone https://github.com/Cryptkeeper/Minetrack Minetrack5`. If you've manually downloaded a release or an archive of the repository, download a fresh copy and extract it into a directory named "Minetrack5". 2. If you've cloned the repository, use `git clone https://github.com/Cryptkeeper/Minetrack Minetrack5`. If you've manually downloaded a release or an archive of the repository, download a fresh copy and extract it into a directory named "Minetrack5".
3. Open the directory and execute `npm install --build-from-source`. This will install updated (and new) dependencies needed by the program. 3. Install Node 12.4.0+ (check your version with node -v)
4. If you have `logToDatabase: true` in your `config.json`, make sure to copy your `database.sql` file into the new directory, otherwise you will lose historical server activity and records. 4. Open the directory and execute `npm install --build-from-source`. This will install updated (and new) dependencies needed by the program.
5. Copy your existing `config.json` and `servers.json` files into the new directory. 5. If you have `logToDatabase: true` in your `config.json`, make sure to copy your `database.sql` file into the new directory, otherwise you will lose historical server activity and records.
4. Build your copy of `dist/`. 6. Copy your existing `config.json` and `servers.json` files into the new directory.
5. If you have previously configured any `faviconOverride` values within `config.json`, you will need to move them to the updated structure. Create a new directory within your Minetrack folder named `favicons/`. 7. Build your copy of `dist/`.
6. If you have previously configured any `minecraft.json` values not included in the new `minecraft_versions.json` file, you will need to update their structure copy them to the new file. 8. If you have previously configured any `faviconOverride` values within `config.json`, you will need to move them to the updated structure. Create a new directory within your Minetrack folder named `favicons/`.
7. Move your custom favicon images into the directory. 9. If you have previously configured any `minecraft.json` values not included in the new `minecraft_versions.json` file, you will need to update their structure copy them to the new file.
8. Open `servers.json` in your favorite editor. 10. Move your custom favicon images into the directory.
9. For any server which you have a custom favicon, set the "favicon" field like so: 11. Open `servers.json` in your favorite editor.
12. For any server which you have a custom favicon, set the "favicon" field like so:
``` ```
{ {
@ -37,4 +38,4 @@ Minetrack now serves a "bundled" copy of the `assets/` directory, instead of the
2. Execute `npm run build` (`npm run dev` is also available, which skips the minimization step and makes active development easier). 2. Execute `npm run build` (`npm run dev` is also available, which skips the minimization step and makes active development easier).
3. Run `ls` to ensure the `dist/` directory has been created. 3. Run `ls` to ensure the `dist/` directory has been created.
Whenever modifying files within `assets/`, you will need to re-run the `npm run build` step to reflect the changes. Those expert few of you may wish to dig into Parcel's [watch and serve](https://parceljs.org/cli.html#watch) CLI commands. Whenever modifying files within `assets/`, you will need to re-run the `npm run build` step to reflect the changes. Those expert few of you may wish to dig into Parcel's [watch and serve](https://parceljs.org/cli.html#watch) CLI commands.