loot/loot.github.io
0
0
Fork 0
mirror of https://github.com/loot/loot.github.io.git synced 2026-07-27 14:13:30 -07:00
Code Issues Packages Projects Releases Wiki Activity

Updated with alternative method.

Browse Source
This commit is contained in:
WrinklyNinja
2014-02-20 12:22:39 -08:00
parent 828754d97e
commit a37a7d7361
2 changed files with 38 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Quickly-Test-Your-Changes-with-Symbolic-Links.md
-17
View File
@@ -1,17 +0,0 @@
The purpose of this page is to explain how symbolic links can be set up to easily test changes made in your local masterlist repository. (Written for a windows system)
### The Process
1. Run BOSS once for the game you intend to create a symbolic link for. This ensures the required directories are created.
2. Turn off `Update masterlist before sorting` in the settings of BOSS and then close the program. If you leave this setting on any changes you make in your local repository will be overwritten by BOSS.
3. Find the directory BOSS uses. This can be reached by entering `%localappdata%/BOSS` into the start menu's search box.
4. Go into the game's folder and `shift+rightclick` on `masterlist.yaml`. Choose to `copy as path` and then delete the file. We're going to create a symbolic link in place of this file and windows won't let us do that if it's still present.
5. Start the command line in administrator mode (required to create symbolic links). The quickest way to do this is to enter `cmd` into the start menu search box and then hit `ctrl+shift+enter`.
6. In the command window enter `mklink <link path> <target path>`. `<link path>` is going to be the absolute path we copied earlier. You can paste this in place by right clicking the command window. `<target path>` is going to be the absolute path to `masterlist.yaml` in your local github repository - you should know where this is.
7. Repeat for each game you intend to work with.
### Things to Know
* To update the masterlist for BOSS in normal use you will need to sync your local repository with github. (BOSS can still do it, but I believe it would cause complications when using git).
* The BOSS report will not be able to give you the SHA for the masterlist it processed. It will always be the one in your local repository though so this isn't an issue.
Quickly-Testing-Your-Masterlist-Changes.md
+38
View File
@@ -0,0 +1,38 @@
You can easily test your masterlist changes *before* syncing them to the online repository, by using one of two methods. Each has advantages and disadvantages, so pick whichever is most suitable for your workflow.
Because both methods make BOSS use your local repository rather than the online one, you'll have to keep your local repository synced with the online one separately - BOSS won't update it for you.
### Using BOSS's "Masterlist Repository URL" Setting
Advantages:
* No messing around with the command line.
* Displays the masterlist revision in the BOSS report correctly.
Disadvantages:
* Requires commits to be made *before* testing, so any fixes for issues found will require additional commits (a trivial disadvantage, really, but still).
#### Method
1. Run BOSS, and open its settings window.
2. Select the game whose masterlist you want to test, and click "Edit Game...".
3. In the Masterlist Repository URL setting's text box, enter the path to your local repository. Eg. if you have the Skyrim masterlist repository at `C:\foo\bar\boss-skyrim`, then put that in the box.
4. Apply the settings, then close and relaunch BOSS. BOSS will now update using your local repository instead of the online one.
### Using Symbolic Links
Advantages:
* Can test changes at any time, without having to make commits first.
Disadvantages:
* Requires some command line action.
* BOSS won't be able to tell you what masterlist revision you're using.
#### The Process
1. Run BOSS once for the game you intend to create a symbolic link for. This ensures the required directories are created.
2. Turn off `Update masterlist before sorting` in the settings of BOSS and then close the program. If you leave this setting on any changes you make in your local repository will be overwritten by BOSS.
3. Find the directory BOSS uses. This can be reached by entering `%localappdata%/BOSS` into the start menu's search box.
4. Go into the game's folder and `shift+rightclick` on `masterlist.yaml`. Choose to `copy as path` and then delete the file. We're going to create a symbolic link in place of this file and windows won't let us do that if it's still present.
5. Start the command line in administrator mode (required to create symbolic links). The quickest way to do this is to enter `cmd` into the start menu search box and then hit `ctrl+shift+enter`.
6. In the command window enter `mklink <link path> <target path>`. `<link path>` is going to be the absolute path we copied earlier. You can paste this in place by right clicking the command window. `<target path>` is going to be the absolute path to `masterlist.yaml` in your local github repository - you should know where this is.
7. Repeat for each game you intend to work with.