|
1 | | -#Phobos |
| 1 | +# Phobos |
2 | 2 | Phobos is script for dumping EVE client data into JSON format. |
3 | 3 |
|
4 | | -###How to use |
| 4 | +### How to use |
5 | 5 |
|
6 | | - python run.py --eve=<path to EVE client> --cache=<path to EVE client cache> [--translate=<language>] --json=<output folder> [--list=<comma-separated list of containers to dump>] |
| 6 | + python run.py --eve=<path to EVE client> --res=<path to shared resource cache> --cache=<path to EVE client cache> [--translate=<language>] --json=<output folder> [--list=<comma-separated list of containers to dump>] |
7 | 7 |
|
8 | | -###Example |
9 | | - (or, how I usually launch it on Linux) |
| 8 | +### Example |
| 9 | +(or, how I usually launch it on Linux) |
10 | 10 |
|
11 | | - $ python run.py --eve="~/.wine_eve/drive_c/Program Files/CCP/EVE/" --cache="~/.wine_eve/drive_c/users/"$USER"/Local Settings/Application Data/CCP/EVE/c_program_files_ccp_eve_tranquility/" --translate=en-us --json=~/Desktop/phobos_dump_tq --list="invtypes, marketProxy()_GetMarketGroups(), phbmetadata" |
| 11 | + $ python run.py --eve="~/.wine_eve/drive_c/Program Files/CCP/EVE/" --res="~/.wine_eve/drive_c/users/Public/Application Data/CCP/EVE/SharedCache" --cache="~/.wine_eve/drive_c/users/"$USER"/Local Settings/Application Data/CCP/EVE/c_program_files_ccp_eve_tranquility/" --translate=en-us --json=~/Desktop/phobos_dump_tq --list="invtypes, marketProxy()_GetMarketGroups(), phbmetadata" |
12 | 12 |
|
13 | | -###Arguments: |
| 13 | +### Arguments: |
14 | 14 |
|
15 | | -* --eve and --cache: just paths to eve client and to folder which contains client cache and settings. |
| 15 | +* --eve: path to EVE client, on Windows usually C:\Program Files (x86)\CCP\EVE\; |
| 16 | +* --res: path to shared cache with resources, on Windows usually C:\ProgramData\CCP\EVE\SharedCache\; |
| 17 | +* --cache: path to client-server specific data (which contains client cache and settings), on Windows usually C:\Users\<user_name>\AppData\Local\CCP\EVE\c_program_files_ccp_eve_tranquility |
16 | 18 | * --translate: specify language to which strings will be translated. You can choose either individual languages (for a list - invoke script with --help argument) or 'multi' option. For individual language, translation will be done in-place (replaces original text with localized text), for multi-language translation - original text is not modified, but new text fields are added, named using <field name>_<language code> convention. Multi-language translation mode is default. |
17 | 19 | * --json: output folder for JSON files. |
18 | 20 | * --list: you can provide list of comma-separated 'containers' to dump, it uses names script prints to stdout. For list of all available names you can launch script without specifying this option (by default it dumps everything it can find). |
19 | 21 |
|
20 | | -###Phobos-specific data |
| 22 | +### Phobos-specific data |
21 | 23 | Besides raw data Phobos pulls from client, it provides two custom containers. |
22 | 24 |
|
23 | | -####phbmetadata |
| 25 | +#### phbmetadata |
24 | 26 | Contains just two parameters: client version and UNIX timestamp of the time script was invoked. |
25 | 27 |
|
26 | | -####phbtraits |
| 28 | +#### phbtraits |
27 | 29 | Traits for various ships. Data has following format: |
28 | 30 |
|
29 | 31 | Returned value: |
|
0 commit comments