📓 Update documentation with list of products
This commit is contained in:
parent
2743ccb6e1
commit
ef7d5d10a3
1 changed files with 21 additions and 6 deletions
27
README.md
27
README.md
|
@ -12,6 +12,8 @@ SWTOR’s patcher is licensed from Solid State Networks, so it is mostly using c
|
|||
|
||||
Also, SWTOR does not use all features offered by SSN. Notably, for public-facing products they do not use the peer-to-peer download of patches; instead all patches are downloaded from a CDN. In addition, they do not use the ```upcoming``` feature where you can preload an upcoming patch before it is released.
|
||||
|
||||
In addition to the SSN patcher, the live game (but not the PTS) can also be installed via BitRaider. We do not cover BitRaider since understanding SSN is enough to install all patches.
|
||||
|
||||
## Terminology
|
||||
SSN uses the following terms; make sure you are familiar with them since we use them as well in documentation and in code.
|
||||
|
||||
|
@ -19,8 +21,9 @@ SSN uses the following terms; make sure you are familiar with them since we use
|
|||
- __```release```__: Colloquially, this is known as a “patch” (or Game Update). For example, release ```264``` in product ```assets_swtor_main``` refers to Game Update 5.2.0. However, not every release can be mapped to a “patch” (or Game Update); sometimes there are multiple releases between two actual “patches”, e.g. because of built errors or because they need to add another hotfix before releasing the “patch”. A release is always an integer starting at ```0```.
|
||||
- __```patch```__: In a SSN sense, a patch refers to the difference between two releases. For example, ```263to264``` is a patch that can be used to update a product from release ```263``` to release ```264```. The first number is called ```from``` while the second number is ```to```. If the ```from``` number is ```-1```, e.g. in patch ```-1to0```, the patch does not store the differences but the full file contents to allow a fresh install. Otherwise, you must already have the ```from``` release installed in order to apply the patch.
|
||||
- __```environment```__: An environment consists of multiple products. For example, the ```live``` environment has products like ```assets_swtor_main``` while the ```pts``` environment has ```assets_swtor_test_main```.
|
||||
- __```manifest```__: Each product has a manifest, a single file that lists all releases and all patches, and specifies which release is the current release (that the launcher must install).
|
||||
|
||||
## SWTOR conventions
|
||||
## Products used by SWTOR
|
||||
|
||||
SWTOR uses the following products:
|
||||
|
||||
|
@ -38,17 +41,29 @@ SWTOR uses the following products:
|
|||
- __```movies_fr_fr```__: Intro movies by Blur in French language.
|
||||
- __```patcher2014```__: The old launcher, now replaced by ```patcher2017```.
|
||||
- __```patcher2017```__: Current version of the launcher, used to download and install patches.
|
||||
- __```retailclient_betatest```__: The client used during the closed beta (2011 and earlier) to play the game.
|
||||
- __```retailclient_cstraining```__: No longer used.
|
||||
- __```retailclient_liveeptest```__: No longer used.
|
||||
- __```retailclient_liveqatest```__: The current client used by QA the day before a maintenance to log into a private server and check that the upcoming patch is correct.
|
||||
- __```retailclient_publictest```__: The current client used to play the game on the PTS.
|
||||
- __```retailclient_squadron157```__: The client used during the closed beta by the Squadron157 testing group to play the game.
|
||||
- __```retailclient_swtor```__: The current client used to play the game in the live environment.
|
||||
|
||||
In addition, there are a few private products which are only reachable through BioWare’s VPN and are not publicly accessible:
|
||||
|
||||
....
|
||||
- ```biomon_cstraining```, ```biomon_liveeptest```, ```biomon_liveqatest```, ```biomon_publictest```, ```biomon_swtor```: The ```Biomongoose``` tool, possibly to monitor performance like CPU and memory usage.
|
||||
- ```byftools_cstraining```, ```byftools_liveeptest```, ```byftools_liveqatest```, ```byftools_publictest```, ```byftools_swtor```: Unknown tools ```ByfTools``` and ```iPen```.
|
||||
- ```heroblade_cstraining```, ```heroblade_liveeptest```, ```heroblade_liveqatest```, ```heroblade_publictest```, ```heroblade_swtor```: The IDE used for editing the game, either by placing new objects into the game world or editing scripts.
|
||||
- ```morpheme_cstraining```, ```morpheme_liveqatest```: Morpheme is a middleware used for character animations.
|
||||
- ```patcher```: The old launcher before the 2014 revamp. No longer in use.
|
||||
- ```playerclient_cstraining```, ```playerclient_liveeptest```, ```playerclient_liveqatest```, ```playerclient_publictest```, ```playerclient_swtor```: A client to play the game, used by the devs instead of ```retailclient```. Has a console and integrates with HeroBlade.
|
||||
- ```repositoryassistant_cstraining```, ```repositoryassistant_liveeptest```, ```repositoryassistant_liveqatest```, ```repositoryassistant_publictest```, ```repositoryassistant_swtor```: unknown
|
||||
- ```repositorybrowser_cstraining```, ```repositorybrowser_liveeptest```, ```repositorybrowser_liveqatest```, ```repositorybrowser_publictest```, ```repositorybrowser_swtor```: The repository browser interfaces with HeroBlade to load 3D models, textures and other assets.
|
||||
- ```toolshub_cstraining```, ```toolshub_liveeptest```, ```toolshub_liveqatest```, ```toolshub_publictest```, ```toolshub_swtor```: Used to launch more tools; most likely SpeedTree, WWise and other middleware.
|
||||
- ```visualizer_cstraining```, ```visualizer_liveeptest```, ```visualizer_liveqatest```, ```visualizer_publictest```, ```visualizer_swtor```: The ```VANViewer``` tool; possibly the tool mentioned by ... in his GDC talk.
|
||||
|
||||
The following products are deprecated and no longer used.
|
||||
|
||||
- ```retailclient_betatest```: The client used during the closed beta (2011 and earlier) to play the game.
|
||||
- ```retailclient_cstraining```: No longer used.
|
||||
- ```retailclient_liveeptest```: No longer used.
|
||||
- ```retailclient_squadron157```: The client used during the closed beta by the Squadron157 testing group to play the game.
|
||||
|
||||
## CDN
|
||||
|
||||
|
|
Loading…
Reference in a new issue