-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathHELP.txt
141 lines (91 loc) · 6.8 KB
/
HELP.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
STT Collection Manager v1.2
Author: August Enzelberger
Project Homepage: https://github.com/augustenz/STT-Collection-Manager
Date: 16/10/2017
STT Collection Manager is a Java application, developed to help manage a Crew collection for Disruptor Beam's Star Trek Timelines game.
=====================================================================
Important Info
This application needs the latest JRE (Java Runtime Environment) to run, it is available for various systems and can be obtained
from www.oracle.com (or https://java.com/en/download/).
JavaFX is used by this application to display charts, it is included in Oracle's JRE so nothing else is needed if that JRE is installed.
Other JREs (like OpenJDK in Linux) need extra packages (like OpenJFX in Linux) to run Java applications that contain JavaFX elements.
In that case either the extra packages can be installed, or Oracle's JRE.
JavaFX is required to run this application.
The database is saved in a folder with the name "STTCollectionManager" in the user's home directory, or in the directory containing the application.
To run the application, double-click on the STTCollectionManager.jar file, or right click and choose
open with and your JRE (java.exe on Windows, OpenJDK or Oracle Java on Linux).
To run the project from the command line, go to the application folder and
type the following:
java -jar "STTCollectionManager.jar"
The Shortcut icons folder contains icon images of various sizes if you wish to make a shortcut
for the application.
=====================================================================
STT Collection Manager consists of six tabs:
1) The Collection tab
This tab contains the Crew Collection table. Here all crew that is currently in the collection can be edited. The editable fields are all the skill fields,
the fused stars field, the level field, the quantity field (in case of multiples) and a checkbox that removes crew from the collection.
Clicking on an editable cell opens it for editing and auto selects-all content for faster editing.
While editing a cell, pressing Tab on the keyboard will move to the next cell.
Tabbing will cycle through all editable columns (except Quantity) and all rows.
Clicking on a column header will sort the table according to that column.
Clicking on the Crew Name field, Race field or any of the Traits in the traits field will open the corresponding wiki page.
Right-clicking on crew members brings up a menu that allows to make a copy of the selected crew member (multiples but with different stats).
2) The Crew tab
This tab contains the Crew table. Here all crew in the game is listed, no fields are editable here except a checkbox that allows adding crew to the
collection.
If this checkbox is already checked, additional clicks on the checkbox will create copies in the Collection (faster way for adding duplicates).
Clicking on a column header will sort the table according to that column.
Clicking on the Crew Name field, Race field or any of the Traits in the traits field will open the corresponding wiki page.
3) The Log tab
This tab contains a textarea where messages regarding the execution of commands can be seen.
4) The Charts tab
This tab contains four charts:
- All Crew pie chart: A pie chart where the balance (quantity of crew/rarity) of the crew in the game can be seen. Each slice represents the number
of crew in game of a certain rarity.
- Crew Collection pie chart: A pie chart where the balance (quantity of crew/rarity) of the collection can be seen. Each slice represents the number
of crew in the collection of a certain rarity.
- Bar chart: A bar chart where on the left the bars represent the number of crew in the game of a certain rarity and on the right the number of crew
in the collection of a certain rarity.
- Stacked bar chart: Similar to the bar chart, only that the bars are stacked instead of being side-by-side.
Every chart will show the number that each graphic element represents as a mouse tooltip.
If a chart is clicked it is opened in a new window where it is enlarged and can be maximized.
5) The Stats tab
This tab has a text field where the number of crew slots can be entered. It has some information about the collection, such as the number of crew/crew
slots, the number of crew in the collection per rarity/the number of crew in the game per rarity and the average crew level.
6) The Settings tab
This tab has three text fields where the URLs used in the app can be changed.
=====================================================================
The Menu Bar
The menu bar consists of seven menus: File, Search, Import, Export, Skin, Font and Help.
1) File
- Download Crew: Drops the crew table (the collection is kept intact) and re fetches all the crew data from the wiki. This is useful when new crew is
added to the wiki.
- Refresh Tables: Refreshes the data shown in the tables, affects only the view, not the data.
- Exit: Saves various settings like the window size, window position etc, shuts down the database and closes the application.
2) Search
Using the search function, both tables can be filtered according to certain criteria. Typing in any text field will immediately query the database and
populate the tables accordingly.
Any info can be entered only partly and the matches (if any) will be shown.
Multiple traits can be entered (they can be separated by a space or a comma) but there will be matches only if they are entered in the same order that they
appear in.
Single traits of course will be matched regardless of their position in the field.
For the search window to open, this menu item has to be pressed when either the Collection tab or the Crew tab are open. It will filter the table that is
open.
3) Import
- Import All Crew: Imports crew data from an .xls file (tab seperated text file) to the "All Crew" table.
- Import Crew Collection: Imports crew data from an .xls file (tab seperated text file) to the "Crew Collection" table.
4) Export
- Export All Crew: Exports all crew in the game to a HTML (crew in collection is shown in bold), text, or xls (tab seperated text file - good for Spreadsheets) file.
- Export Crew Collection: Exports the crew collection to a HTML, text, or xls (tab seperated text file - good for Spreadsheets) file.
5) Skin
Lists skins available on the system and allows changing the current skin. This setting is saved.
6) Font
- Increase Font Size: Increases the font size.
- Decrease Font Size: Decreases the font size.
- Reset Font Size: Resets the font size (12).
- Change Font: Lists fonts found on the system and allows to change the font being used in the tables.
These settings are saved.
7) Help
- Help: Probably this readme file :)
- Info: Info about the system.
- About: The application credits.