Skip to content

chore: 106015: update documents until shortcuts are properly supported #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArisayaDragon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: 106015: update documents until shortcuts are properly supported #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/Programmer_Guides/Getting_Started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,13 +133,17 @@ Collection and Extension folders. To do this:

1. Create a folder `Collection` in `TranscendenceDev/Transcendence/Game`
2. Create a folder `Extensions` in `TranscendenceDev/Transcendence/Game`
3. Create a shortcut inside `TranscendenceDev/Transcendence/Game/Collection` to
3. Create a symlink inside `TranscendenceDev/Transcendence/Game/Collection` to
the `Collection` folder of the existing Transcendence installation
4. Create a shortcut inside `TranscendenceDev/Transcendence/Game/Extensions` to
* `mklink /D "{location of repo}/TranscendenceDev/Transcendence/Game/Collection/ExternalCollection" "{location of external transcendence}/Transcendence/Collection"`
* Replace the text in `{}` with appropriate file paths.
* An admin cmd prompt should not be necessary unless the folder permissions require it.
4. Create a symlink inside `TranscendenceDev/Transcendence/Game/Extensions` to
the `Extensions` folder of the existing Transcendence installation
* `mklink /D "{location of repo}/TranscendenceDev/Transcendence/Game/Extensions/ExternalExtensions" "{location of external transcendence}/Transcendence/Extensions"`

Notes:
* For windows even a basic `.lnk` shortcut will work. It is not mandatory to symlink or hardlink the directory
* For windows a basic `.lnk` shortcut is not yet supported.
* This has not been tested on Linux but it should still work
* If the game says that the API version of the Transcendence Universe is too high you need
to download a new copy of TranscendenceNext.zip and follow the setup instructions again
Expand Down