Skip to content
This repository was archived by the owner on Jul 6, 2022. It is now read-only.

Commit dcf2b1d

Browse files
committed
Documentation complete.
1 parent 40c227e commit dcf2b1d

7 files changed

Lines changed: 215 additions & 71 deletions

File tree

‎app/js/UIPanels.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ var UIPanels = {
4747
{submit: {class: 'submit-join', text: 'Join Fleet', onClick: 'UIPanels.showJoinPanel()'}},
4848
{button: {class: 'leave-fleet', text: 'Leave Standing Fleet', onClick: 'leaveFleet()'}},
4949
],
50-
error: error
50+
error: error,
51+
footer: '<a href="/docs/">What is this site?</a><br />&copy 2014 Goonswarm Federation'
5152
};
5253

5354
UIPanels.showPanel(panel, callback);

‎app/styles/main.css‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,10 @@ div#page, div#content-wrapper { position: relative; height: 100%; width: 100%; b
241241
border: none;
242242
}
243243

244+
#bottom-menu a {
245+
color: #fff;
246+
}
247+
244248
input.info-string {
245249
background: transparent !important;
246250
border: 0 !important;
@@ -1164,3 +1168,71 @@ border-top: 0.16rem solid #333;
11641168
z-index: 9001;
11651169
background: #000 !important;
11661170
}
1171+
1172+
/*/
1173+
/ / DOCUMENTATION
1174+
*/
1175+
#docs {
1176+
background: linear-gradient(#333, #222 1%);
1177+
margin: 0 auto;
1178+
padding: 10px;
1179+
text-align: left;
1180+
width: 85%;
1181+
}
1182+
1183+
#docs img {
1184+
background-color: #fff;
1185+
border-radius: 4px;
1186+
padding: 0.5rem;
1187+
}
1188+
1189+
#docs img[alt='GARPA'] {
1190+
float: right;
1191+
margin: 0 0 1rem 1rem;
1192+
}
1193+
1194+
#docs h1,
1195+
#docs h2,
1196+
#docs h3 {
1197+
color: #ffcc2a;
1198+
font-family: 'Lato', sans-serif !important;
1199+
font-weight: 700;
1200+
line-height: 25px;
1201+
margin-top: 1.5rem;
1202+
padding: 0.5rem 0.4rem 0.5rem 0;
1203+
text-transform: uppercase;
1204+
text-shadow: 0 0 0.2em #ffcc2a;
1205+
}
1206+
1207+
#docs h1 { font-size: 3rem; }
1208+
#docs h2 { font-size: 2.25rem; }
1209+
#docs h3 { font-size: 2rem; }
1210+
1211+
#docs blockquote {
1212+
font-style: italic;
1213+
}
1214+
1215+
#docs p {
1216+
text-align: justify;
1217+
}
1218+
1219+
#docs p.footer {
1220+
color: #666;
1221+
font-size: 1rem;
1222+
text-align: right;
1223+
}
1224+
1225+
#docs a,
1226+
#docs p,
1227+
#docs li {
1228+
font-size: 14pt;
1229+
margin-bottom: 1rem;
1230+
}
1231+
1232+
#docs ol {
1233+
margin-left: 5rem !important;
1234+
}
1235+
1236+
#docs ol li {
1237+
list-style-type: decimal;
1238+
}

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
"jade": "^1.5.0",
4444
"lodash": "2.4.1",
4545
"main-bower-files": "^2.0.0",
46+
"marked": "^0.3.2",
4647
"moment": "^2.8.3",
4748
"mongoose": "^3.8.16",
4849
"mongoose-q": "0.0.13",

‎public/images/garpa_logo.png‎

55.3 KB
Loading

‎server/views/docs/docs.jade‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
:markdown
2+
# Standing Fleet
3+
![GARPA](/images/garpa_logo.png "Practical Solutions, Unorthodox Methods")
4+
> Visualized Alliance Intelligence
5+
6+
## What Is This Site?
7+
8+
Some of you may have already heard about this app, but for those who haven't, allow me to introduce Standing Fleet. Standing Fleet is the next application I'm developing for GARPA and will be aimed at replacing the alliance regional intel channels. It's a visual representation of what the intel channels usually are, except easier to read and easier to determine if a system you're interested has had it's status updated recently.
9+
10+
I'm going to be asking Space Violence and Freedom Squad to participate in using this tool as much as possible as a beta test of the actual general release to the rest of the alliance. Please use this by making a standing fleet in the app daily when the actual JU- standing fleet is formed, and post the link in the fleet's MOTD. Joining a fleet is just as easy as clicking the link.
11+
12+
Please note that this has not been generally announced and this is something I'd like to keep internal to these squads for the time being. Remember, loose lips sink ships.
13+
14+
### Getting Started
15+
http://standing-fleet.goonswarm.org/
16+
17+
Make sure you trust the domain before you start. Once you do, refresh the browser.
18+
19+
Since we're not currently in a fleet, let's create one. Clicking 'Create Fleet' will take you to an optional page where you can set a password for a given fleet.
20+
![Alt](http://i.imgur.com/klsxVeD.png)
21+
22+
Fill one out or leave it blank and click 'Create Fleet':
23+
![Alt](http://i.imgur.com/E0ggM7I.png)
24+
25+
You'll be redirected to your new Standing Fleet link similar to:
26+
#### http://standing-fleet.goonswarm.org/vIuJ451H2LDG5KUI/
27+
28+
This now becomes a joinable link for your fellow pilots in game. Copy and paste it into the MOTD of your fleet.
29+
![Alt](http://i.imgur.com/60nfQim.png)
30+
31+
### Overview
32+
Now that you've actually joined a standing fleet, let's take a look around. As you can see from the tabs on the top, this app is broken up into 6 basic sections:
33+
1. HUD
34+
1. Regional Map
35+
1. Hostile List
36+
1. Member List
37+
1. Scan List
38+
1. Event History
39+
40+
41+
### Regional Map
42+
The regional map obviously shows you a tactical overview of reported hostile activity for your current region. It will automatically center to your current system, but you can pan and zoom the map around. Additionally, it will keep track of where friendly eyes are at, so you can plan your route accordingly.
43+
![Alt](http://i.imgur.com/LVRSjw6.png)
44+
45+
### Hostile List
46+
The hostile list is a collection of all currently reported hostiles and data about their ships. Their standings are automatically parsed against standings.goonfleet.com. Clicking on pilot names or their alliance names will bring up the in-game info on either. Clicking on the destination marker (the left icon) will set an in-game destination to the system they're spotted in and the target marker (the right icon) will pull up their details on zkillboard.
47+
![Alt](http://i.imgur.com/8jXEspW.png)
48+
49+
### Member List
50+
Standing fleet will also give you visibility to other members in the fleet, including the same destination and zkillboard links, but additionally a quick link to start a converstation with them. No more tackled carriers and nobody knows where to go help them at!
51+
![Alt](http://i.imgur.com/667Wqh2.png)
52+
53+
### Scan List
54+
Standing Fleet also has the ability to keep track of directional scans, similar to that dashboard.info site, including an on/off grid toggle.
55+
![Alt](http://i.imgur.com/NAbE31n.png)
56+
57+
### Event History
58+
The event history functions very similarly to the fleet events for the in-game fleet. You can see a historical timeline of exactly what has happened in your fleet.
59+
![Alt](http://i.imgur.com/URwFLKV.png)
60+
61+
### Options Menu
62+
In the bottom left corner, there's a link to the options menu where you can find out information regarding the fleet (like the Fleet Key), including your own Pilot Key (more on this later). There's also a fully qualified link you can select-all and copy for quick pasting to your fellow pilots.
63+
![Alt](http://i.imgur.com/Xc13Bcg.png)
64+
65+
### Heads Up Display
66+
In case you want to just minimally view the system and neighboring systems status, just click on the HUD view.
67+
![Alt](http://i.imgur.com/7C2Bsm0.png)
68+
![Alt](http://i.imgur.com/QntLPiM.png)
69+
![Alt](http://i.imgur.com/KgcSSV9.png)
70+
71+
### Reporting Status
72+
Standing Fleet crowd sources the intel for a given region by taking two kinds of inputs: copy/paste of local and copy/paste of d-scan.
73+
74+
For reporting status of a system, one does the following:
75+
76+
1. Click on the list of names in local.
77+
1. Ctrl-A + Ctrl-C
78+
1. Click on 'Report Local' on the bottom menu bar.
79+
![Alt](http://i.imgur.com/gYDaBcK.png)
80+
1. Paste results.
81+
![Alt](http://i.imgur.com/5abNcPv.png)
82+
83+
No more carefully picking names out of the list and dragging them to the intel channel. No more worrying about whether or not the person you're reporting is blue or not. Standing fleet will parse these pilots (and whitelist blue pilots) and mark them hostile based on their standings to standings.goonfleet.com. Notice that I copy pasted a 30+ list of local, but it's only saying that 7 of them are hostile based on their standings lookup:
84+
![Alt](http://i.imgur.com/ugNrkRa.png)
85+
86+
Updating Hostile Details
87+
For the most part, people largely care about whether or not a system is hostile and less about what kind of ships the hostiles are in. Although, sometimes that's important. If you happen to know the ship type of a hostile, you can click on the Hostiles List and then click on the 'Non Visual' link to bring up the details window for that hostile. Fill out the form and click submit.
88+
![Alt](http://i.imgur.com/ZrlcdiV.png)
89+
90+
A few seconds later, your bros know what kind of ship that guy is in:
91+
![Alt](http://i.imgur.com/Xy9Yc4w.png)
92+
93+
Hostiles will be auto-expired in 15 minutes, or will be updated if they are reported in another system. Yes, their ship details will automatically preserved.
94+
95+
### Directional Scans
96+
Another thing that Standing Fleet can keep track of is directional scans. To submit a directional scan, simply do the following:
97+
98+
1. Open up your directional scan window and scan 360 with full resolution.
99+
1. Ctrl-A + Ctrl-C
100+
1. Click 'Report Scan' on the bottom menu bar.
101+
![Alt](http://i.imgur.com/aTzkjyT.png)
102+
1. Paste results
103+
![Alt](http://i.imgur.com/04r2NF2.png)
104+
105+
Results are automatically submitted to your fleetmates and organized by ship type:
106+
![Alt](http://i.imgur.com/axUuyk6.png)
107+
108+
Out of Game Linking
109+
So you've probably been reading all of this and thinking, that's really great Tarei. Too bad I'll never use it because I already have too many windows open on my client and one more for the IGB is a bridge too far. Ok, so fire up chrome (or firefox if you're one of *those people*) and plunk in:
110+
111+
http://standing-fleet.goonswarm.org/
112+
113+
You're now going to get a different login form than you did in game. This time, fill out the form with your [Goon ESA](https://goonfleet.com/esa/) credentials. Use the ones you use for the wiki (ie: keep spaces in your usernames, don't convert them to underscores).
114+
![Alt](http://i.imgur.com/yEoNc6Y.png)
115+
116+
Now it's going to ask for your pilot key.
117+
![Alt](http://i.imgur.com/L2IGnxy.png)
118+
119+
Remember where that's located? That's right, it's back on the options menu. Go copy and paste that sumbitch back here.
120+
![Alt](http://i.imgur.com/MmCjvN8.png)
121+
122+
Now you've linked your pilot and can click on the fleet link for that pilot out of game.
123+
![Alt](http://i.imgur.com/A1i7oIR.png)
124+
125+
Feel free to minimize the IGB Standing Fleet window now, but just make sure that you keep it open to keep the session open.
126+
127+
## Things We're Planning
128+
One of the things we want to do is provide a stand-alone client that will watch the usual intel channels (ie: DEK.CFC, etc) and report those as well. We're still hoping that in-app intel reports become the preferred way, but this will help close the gap. Additionally, the stand-alone app will have a toggle-able clipboard watch mode, so that all you would have to do is ctrl-a + ctrl-c local. It'll detect that it's a copypaste of local (and not your credit card pins) and post it automatically. This would be particularly useful for people who could park alts at various regional chokepoints and macro ctrl-a + ctrl-c every 60 seconds. Instant traffic cop.
129+
130+
Reportable information about systems that don't have to do with pilots. For example, reporting that a system has a wormhole, or gatecamp information would be particularly useful.
131+
132+
We're also thinking about providing a way to hook into GTS to provide route and jump bridge guidance. That's going to be a bit off, but still something we're thinking about doing.
133+

‎server/views/docs/index.jade‎

Lines changed: 2 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -5,74 +5,6 @@ block content
55
document.documentElement.classList.add('docs');
66

77
#docs
8-
h2 What Is This Site?
9-
p Standing Fleet crowd sources the intel for a given region by taking two kinds of inputs: copy/paste of local and copy/paste of d-scan.
8+
include docs
109

11-
p For reporting status of a system, one does the following:
12-
ol
13-
li Click on the list of names in local.
14-
li Ctrl-A + Ctrl-C
15-
li
16-
| Click on 'Report Local' on the bottom menu bar.
17-
img(src='http://i.imgur.com/gYDaBcK.png')
18-
li
19-
| Paste results.
20-
img(src='http://i.imgur.com/5abNcPv.png')
21-
22-
p No more carefully picking names out of the list and dragging them to the intel channel. No more worrying about whether or not the person you're reporting is blue or not. Standing fleet will parse these pilots (and whitelist blue pilots) and mark them hostile based on their standings to standings.goonfleet.com. Notice that I copy pasted a 30+ list of local, but it's only saying that 7 of them are hostile based on their standings lookup:
23-
img(src='http://i.imgur.com/ugNrkRa.png')
24-
25-
26-
//-
27-
//- Updating Hostile Details
28-
//- For the most part, people largely care about whether or not a system is hostile and less about what kind of ships the hostiles are in. Although, sometimes that's important. If you happen to know the ship type of a hostile, you can click on the Hostiles List and then click on the 'Non Visual' link to bring up the details window for that hostile. Fill out the form and click submit.
29-
//- ZrlcdiV.png
30-
//-
31-
//- A few seconds later, your bros know what kind of ship that guy is in:
32-
//- Xy9Yc4w.png
33-
//-
34-
//- Hostiles will be auto-expired in 15 minutes, or will be updated if they are reported in another system. Yes, their ship details will automatically preserved.
35-
//-
36-
//- Directional Scans
37-
//- Another thing that Standing Fleet can keep track of is directional scans. To submit a directional scan, simply do the following:
38-
//- Open up your directional scan window and scan 360 with full resolution.
39-
//- Ctrl-A + Ctrl-C
40-
//- Click 'Report Scan' on the bottom menu bar.
41-
//- aTzkjyT.png
42-
//-
43-
//- Paste results
44-
//- 04r2NF2.png
45-
//-
46-
//- Results are automatically submitted to your fleetmates and organized by ship type:
47-
//- axUuyk6.png
48-
//-
49-
//- Out of Game Linking
50-
//- So you've probably been reading all of this and thinking, that's really great Tarei. Too bad I'll never use it because I already have too many windows open on my client and one more for the IGB is a bridge too far. Ok, so fire up chrome (or firefox if you're one of /those people/) and plunk in:
51-
//-
52-
//- https://standing-fleet.herokuapp.com/
53-
//-
54-
//- You're now going to get a different login form than you did in game. This time, fill out the form with your Goon ESA (https://goonfleet.com/esa/) credentials. Use the ones you use for the wiki (ie: keep spaces in your usernames, don't convert them to underscores).
55-
//- yEoNc6Y.png
56-
//-
57-
//- Now it's going to ask for your pilot key.
58-
//- L2IGnxy.png
59-
//-
60-
//- Remember where that's located? That's right, it's back on the options menu. Go copy and paste that sumbitch back here.
61-
//- MmCjvN8.png
62-
//-
63-
//- Now you've linked your pilot and can click on the fleet link for that pilot out of game.
64-
//- A1i7oIR.png
65-
//-
66-
//- Feel free to minimize the IGB Standing Fleet window now, but just make sure that you keep it open to keep the session open.
67-
//-
68-
//- Things We're Planning
69-
//- One of the things we want to do is provide a stand-alone client that will watch the usual intel channels (ie: DEK.CFC, etc) and report those as well. We're still hoping that in-app intel reports become the preferred way, but this will help close the gap. Additionally, the stand-alone app will have a toggle-able clipboard watch mode, so that all you would have to do is ctrl-a + ctrl-c local. It'll detect that it's a copypaste of local (and not your credit card pins) and post it automatically. This would be particularly useful for people who could park alts at various regional chokepoints and macro ctrl-a + ctrl-c every 60 seconds. Instant traffic cop.
70-
//-
71-
//- Reportable information about systems that don't have to do with pilots. For example, reporting that a system has a wormhole, or gatecamp information would be particularly useful.
72-
//-
73-
//- We're also thinking about providing a way to hook into GTS to provide route and jump bridge guidance. That's going to be a bit off, but still something we're thinking about doing.
74-
//-
75-
//- In Closing
76-
//- I'm working on getting a bug tracker for this, but in the meantime, let's keep it in this thread. Additionally, please let me know what works for you and what doesn't work for you. Since this is based on crowd sourcing, it's only going to really work better when there are more people using this. Even if it's just minimized the more people in fleet using this the better.
77-
//-
78-
//- Any questions?
10+
p.footer &copy; 2014 Goonswarm Federation

‎server/views/main/index.jade‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ block content
5353
#bottom-menu-unlink.menu-button
5454
i.fa.fa-sign-out
5555
span UNLINK
56+
#bottom-menu-docs.menu-button
57+
a(href='/docs/', target='_blank')
58+
i.fa.fa-question-circle
59+
span HELP
60+
5661
#bottom-menu-menu.menu-button
5762
i.fa.fa-cog
5863
span MENU

0 commit comments

Comments
 (0)