Skip to content
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.

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

Ship guide reworks #1534

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c6fe895
Ship Guide Reworks
Actualcatmoment Jun 17, 2024
34597e6
Merge branch 'new-frontiers-14:master' into Ship-Guide-Reworks
Actualcatmoment Jun 17, 2024
a042786
Update Resources/ServerInfo/_NF/Guidebook/Hiring.xml
Actualcatmoment Jun 17, 2024
4f03010
Update Resources/ServerInfo/_NF/Guidebook/Hiring.xml
Actualcatmoment Jun 17, 2024
df53488
Update Resources/ServerInfo/_NF/Guidebook/Piloting.xml
Actualcatmoment Jun 17, 2024
db8cc99
Update Resources/ServerInfo/_NF/Guidebook/Piloting.xml
Actualcatmoment Jun 17, 2024
0e947d5
Update Resources/ServerInfo/_NF/Guidebook/Shipyard/Spirit.xml
Actualcatmoment Jun 17, 2024
d61ac15
Update Resources/ServerInfo/_NF/Guidebook/Shipyard/Searchlight.xml
Actualcatmoment Jun 17, 2024
9bb6e5f
Update Resources/ServerInfo/_NF/Guidebook/Shipyard/Searchlight.xml
Actualcatmoment Jun 17, 2024
5a6c206
Update Resources/ServerInfo/_NF/Guidebook/Hiring.xml
Actualcatmoment Jun 17, 2024
2338dd2
Update Spirit.xml
Actualcatmoment Jun 17, 2024
15fe2f2
Update Resources/ServerInfo/_NF/Guidebook/Piloting.xml
Actualcatmoment Jun 17, 2024
4561b39
Apply suggestions from code review
Actualcatmoment Jun 17, 2024
a0e66a5
Update guides.ftl
Actualcatmoment Jun 17, 2024
fabfc9c
Update Resources/ServerInfo/_NF/Guidebook/Piloting.xml
Actualcatmoment Jun 17, 2024
e14c245
Update Ceres.xml
Actualcatmoment Jun 17, 2024
789dbc9
Update Kilderkin.xml
Actualcatmoment Jun 17, 2024
fb2c838
Update Legman.xml
Actualcatmoment Jun 17, 2024
c0edf8e
Update Liquidator.xml
Actualcatmoment Jun 17, 2024
422e2fe
Added Expeditions guidebook entry
Actualcatmoment Jun 17, 2024
a321cde
Update Lantern.xml
Actualcatmoment Jun 18, 2024
d8cb0cc
Guidebook rewrite
whatston3 Jun 18, 2024
3c92231
Guidebook revisions
whatston3 Jun 18, 2024
0f8c14a
Restructured hiring guidebook page
whatston3 Jun 19, 2024
dadfd78
Merge branch '2024-06-18-Ship-Guide-Reworks-Rewrite' into Ship-Guide-…
whatston3 Jun 19, 2024
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
20 changes: 19 additions & 1 deletion Resources/Locale/en-US/_NF/guidebook/guides.ftl
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Base entries
guide-entry-nf14 = New Frontier
guide-entry-bank = NT Galactic Bank
guide-entry-piloting = Piloting
guide-entry-hiring = Hiring Crew
guide-entry-expeditions = Expeditions
guide-entry-shipyard = Shipyard

# Expedition faction entries
guide-entry-expedition-faction-carp = Carp
guide-entry-expedition-faction-cultists = Cultists
guide-entry-expedition-faction-dinosaurs = Dinosaurs
guide-entry-expedition-faction-explorers = Explorers
guide-entry-expedition-faction-flesh = Flesh
guide-entry-expedition-faction-gangers = Gangers
guide-entry-expedition-faction-mercenaries = Mercenaries
guide-entry-expedition-faction-silicons = Silicons
guide-entry-expedition-faction-syndicate = Syndicate
guide-entry-expedition-faction-xenos = Xenos

# Shipyard entries
guide-entry-shipyard-ambition = Ambition
guide-entry-shipyard-brigand = Brigand
guide-entry-shipyard-ceres = Ceres
Expand All @@ -12,4 +30,4 @@ guide-entry-shipyard-legman = Legman
guide-entry-shipyard-liquidator = Liquidator
guide-entry-shipyard-pioneer = Pioneer
guide-entry-shipyard-searchlight = Searchlight
guide-entry-shipyard-spirit = Spirit
guide-entry-shipyard-spirit = Spirit
3 changes: 2 additions & 1 deletion Resources/Prototypes/_NF/Guidebook/bank.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
- type: guideEntry
id: Bank
name: guide-entry-bank
text: "/ServerInfo/_NF/Guidebook/Bank.xml"
text: "/ServerInfo/_NF/Guidebook/Bank.xml"
whatston3 marked this conversation as resolved.
Show resolved Hide resolved
priority: 0
67 changes: 67 additions & 0 deletions Resources/Prototypes/_NF/Guidebook/expeditions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
- type: guideEntry
id: Expeditions
name: guide-entry-expeditions
text: "/ServerInfo/_NF/Guidebook/Expeditions.xml"
priority: 3
# children: # TODO: flesh these out
# - ExpeditionFactionCarp
# - ExpeditionFactionCultists
# - ExpeditionFactionDinosaurs
# - ExpeditionFactionExplorers
# - ExpeditionFactionFlesh
# - ExpeditionFactionGangers
# - ExpeditionFactionMercenaries
# - ExpeditionFactionSilicons
# - ExpeditionFactionSyndicate
# - ExpeditionFactionXenos

# TODO: flesh these out
# - type: guideEntry
# id: ExpeditionFactionCarp
# name: guide-entry-expedition-faction-carp
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Carp.xml"

# - type: guideEntry
# id: ExpeditionFactionCultists
# name: guide-entry-expedition-faction-cultists
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Cultists.xml"

# - type: guideEntry
# id: ExpeditionFactionDinosaurs
# name: guide-entry-expedition-faction-dinosaurs
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Dinosaurs.xml"

# - type: guideEntry
# id: ExpeditionFactionExplorers
# name: guide-entry-expedition-faction-explorers
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Explorers.xml"

# - type: guideEntry
# id: ExpeditionFactionFlesh
# name: guide-entry-expedition-faction-flesh
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Flesh.xml"

# - type: guideEntry
# id: ExpeditionFactionGangers
# name: guide-entry-expedition-faction-gangers
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Gangers.xml"

# - type: guideEntry
# id: ExpeditionFactionMercenaries
# name: guide-entry-expedition-faction-mercenaries
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Mercenaries.xml"

# - type: guideEntry
# id: ExpeditionFactionSilicons
# name: guide-entry-expedition-faction-silicons
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Silicons.xml"

# - type: guideEntry
# id: ExpeditionFactionSyndicate
# name: guide-entry-expedition-faction-syndicate
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Syndicate.xml"

# - type: guideEntry
# id: ExpeditionFactionXenos
# name: guide-entry-expedition-faction-xenos
# text: "/ServerInfo/_NF/Guidebook/ExpeditionFactions/Xenos.xml"
5 changes: 5 additions & 0 deletions Resources/Prototypes/_NF/Guidebook/hiring.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- type: guideEntry
id: Hiring
name: guide-entry-hiring
text: "/ServerInfo/_NF/Guidebook/Hiring.xml"
priority: 1
3 changes: 3 additions & 0 deletions Resources/Prototypes/_NF/Guidebook/nf14.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
priority: -1
children:
- Bank
- Hiring
- Piloting
- Expeditions
- Shipyard
5 changes: 5 additions & 0 deletions Resources/Prototypes/_NF/Guidebook/piloting.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- type: guideEntry
id: Piloting
name: guide-entry-piloting
text: "/ServerInfo/_NF/Guidebook/Piloting.xml"
priority: 2
1 change: 1 addition & 0 deletions Resources/Prototypes/_NF/Guidebook/shipyard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: Shipyard
name: guide-entry-shipyard
text: "/ServerInfo/_NF/Guidebook/Shipyard.xml"
priority: 4
children:
- ShipyardAmbition
- ShipyardBrigand
Expand Down
34 changes: 19 additions & 15 deletions Resources/ServerInfo/_NF/Guidebook/Bank.xml
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
<Document>
# NT Galactic Bank
# NT Galactic Bank

As a contractor with Nanotrasen, you have a persistent bank account.
Money that you [bold]deposit[/bold] at an [color=#44cc00]ATM[/color] on Frontier Outpost or Tinnia's rest will be stored in your account.

NT has opened up it's banking industry to regular citizens, guaranteeing up to (int32.MAX)!

## ATMs
<Box>
<GuideEntityEmbed Entity="ComputerBankATM"/>
<GuideEntityEmbed Entity="SpaceCash1000"/>
</Box>
You can access your personal bank account at any time to withdraw or deposit funds at any [color=#44cc00]Galactic Bank ATM[/color]
<Box>
<GuideEntityEmbed Entity="ComputerBankATM"/>
<GuideEntityEmbed Entity="SpaceCash1000"/>
</Box>
You can access your personal bank account at any time to withdraw your hard-earned [color=#44cc00]Spesos[/color] at any [color=#44cc00]Galactic Bank ATM[/color].

NT currently only recognizes [color=#44cc00]Spesos[/color] or "SpaceBucks" as legal tender.
Only ATMs on Frontier Outpost and Tinnia's Rest allow you to deposit money.
Make sure you deposit your cash and sell off your ship before ending your shift!

## Account Access
<Box>
<GuideEntityEmbed Entity="VendingMachineAstroVend"/>
<GuideEntityEmbed Entity="VendingMachineAmmo"/>
</Box>
Access to your bank account is restricted to [color=#44cc00]Galactic Bank ATMs[/color] and a regulated variety of [color=#44cc00]Vending machines[/color]
<Box>
<GuideEntityEmbed Entity="VendingMachineAstroVend"/>
<GuideEntityEmbed Entity="ComputerCargoOrders"/>
<GuideEntityEmbed Entity="VendingMachineAmmo"/>
</Box>
Your bank account can be used through [color=#44cc00]Galactic Bank ATMs[/color], [color=#44cc00]cargo computers[/color], and [color=#44cc00]vending machines[/color].

Most in-person transactions you will deal in will be directly with [color=#44cc00]Spesos[/color]
When trading with other people, you'll usually deal in stacks of [color=#44cc00]Spesos[/color].
Be sure to deposit these at an [color=#44cc00]ATM[/color] before ending your shift.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Carp

A land-dwelling version of the hostile space fauna, these carp have adapted to life under gravity.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Cultists

Servants of Nar'Sie, these fanatics will stop at nothing to raise their sleeping goddess.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Dinosaurs

Megafauna from our more savage worlds, these behemoths pose a risk to corporate property.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Explorers

An independent group of scavengers squatting on corporate land. Help enforce our claim over their little nest.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Flesh

Biological abominations from experiments gone awry, these shambling freaks are a menace.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Gangers

Urchins, miscreants, and other social detritus banded together. Disorganized and chaotic, they're a nuisance.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Mercenaries

Death squads for hire from the various fringes of space. Shouldn't have contracted work in Nanotrasen's territory.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Silicons

Rogue robots, drones, and other silicon intelligences. Valuable scrap, if nothing else.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Syndicate

Agents from hostile corporations. Handle with extreme prejudice.
</Document>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Document>
# Xenos

Various nests of highly territorial alien bioweapons. Smoke 'em out.
</Document>
33 changes: 33 additions & 0 deletions Resources/ServerInfo/_NF/Guidebook/Expeditions.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<Document>
# Salvage Expeditions
<Box>
<GuideEntityEmbed Entity="ComputerSalvageExpedition"/>
<GuideEntityEmbed Entity="TelecomServerFilledShuttle"/>
</Box>
Expeditions are adventures that you can go on with your crew.[br][/br]
Your ship will jump to a planet and you need to complete an objective in a limited time.[br][/br]
When that time runs out, the ship jumps back, [bold]whether you're on it or not[/bold].

Ships purchased at Frontier Outpost [bold]cannot[/bold] go on expedition, but [italic]any purchased at [bold]Expeditionary Lodge[/bold] can[/italic].
You will need to use the [color=#a4885c]salvage console[/color] onboard.

To go on an expedition:
- Pilot your ship so there is 200 m of empty space in each direction.
- Use the [color=#a4885c]salvage console[/color].
- Pick one of the five missions offered to you.
- Note the enemy, conditions, total time, and objectives for the mission.
- Buckle into a seat to avoid falling down.

Tips for expeditions:
- Start with easier missions and progress to harder ones as you get better equipped.
- Different enemy types have different strengths and weaknesses. Vary your loadout to best deal with each.
- If you don't think you can win a fight, don't take it.

When you arrive on-site, you'll be told which direction the objective is in.
There'll be a building in that direction; break in and complete your objective.
Note: North is towards the top of the screen in default rotation (NUMPAD 8).

While planetside, you can't communicate via radio with the wider Frontier Sector.
If you don't have a [color=#a4885c]telecommunication server[/color] on your ship, your headset won't work.
Note that [color=#a4885c]handheld radios[/color] work without a server.
</Document>
21 changes: 21 additions & 0 deletions Resources/ServerInfo/_NF/Guidebook/Hiring.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<Document>
# Hiring Crew
<Box>
<GuideEntityEmbed Entity="ComputerStationRecords"/>
<GuideEntityEmbed Entity="ClothingHeadsetGrey" Caption="headset"/>
<GuideEntityEmbed Entity="IntercomCommon"/>
</Box>
As the Captain of a Nanotrasen vessel, you have the authority to hire and fire crew members, and to delegate work.
There are two ways to hire crew:
- Use the [color=#a4885c]station records computer[/color] on your ship to open crew slots. Players that join later can spawn in on your ship.
- Invite other players to join your crew through in-game communications.

Crew membership is informal - you don't need to sign any forms, but feel free to roleplay!
It's a good idea to make sure your crew understand:
- What you expect of them (What tasks should they do? Who do they report to or work with?)
- What they can expect from you (An hourly wage? A split of rewards? The promise of adventure?).

As a Captain, remember:
- You're responsible for the well-being of your crew.
- A Captain's only as good as their word!
</Document>
44 changes: 25 additions & 19 deletions Resources/ServerInfo/_NF/Guidebook/NewFrontier14.xml
Original file line number Diff line number Diff line change
@@ -1,28 +1,34 @@
<Document>
# NT New Frontiers Program
# NT New Frontiers Program

Thank you for signing up for the New Frontiers Program!
Thank you for signing up for the New Frontiers Program! As a Nanotrasen employee, you're helping to develop the furthest reaches of space!

After countless hours of research and number crunching, the top NT insurance agents have found it more profitable to offload the logistics cost on to you! Our dedicated employees!
[color=#33bbff]If you'd like a hand, ask on the radio, or talk to somebody.[/color]
The [color=#dd0000]Valet[/color] or [color=#009933]Station Representative[/color] should be able to help, they're to the right of medbay.

## Profit Avenues
<Box>
<GuideEntityEmbed Entity="ComputerBankATM"/>
<GuideEntityEmbed Entity="SpaceCash1000"/>
<GuideEntityEmbed Entity="ComputerShipyard"/>
</Box>
You can access your personal bank account at any time to withdraw or deposit funds at any [color=#44cc00]Galactic Bank ATM[/color]
## Economy
<Box>
<GuideEntityEmbed Entity="ComputerBankATM"/>
<GuideEntityEmbed Entity="SpaceCash1000"/>
<GuideEntityEmbed Entity="ComputerShipyard"/>
</Box>
Any money that you make is [bold]yours[/bold], and will be available in future shifts if deposited at a [color=#44cc00]Galactic Bank ATM[/color] on Frontier Outpost or Tinnia's Rest.

Join a ship's crew to help make as much money and deliver as much value to NT as possible, or use the [color=#cccc00]Shipyard Console[/color] to purchase your own.
To make money, why not:
- Join a ship's crew? Ask on the radio if anyone needs extra crew, and work to help your captain.
- Get a job on station? Ask the [color=#009933]Station Representative[/color] (follow the SR signs) if anything needs doing.
- Use a [color=#cccc00]shipyard console[/color] to purchase your own ship?

## Provisions
<Box>
<GuideEntityEmbed Entity="VendingMachineAstroVend"/>
<GuideEntityEmbed Entity="VendingMachineAmmo"/>
<GuideEntityEmbed Entity="MachineCryoSleepPod"/>
</Box>
NT has opened up back stock of many machine boards taken from excess station construction projects, along with many other amenities to assist in taming the frontier.
## Amenities
<Box>
<GuideEntityEmbed Entity="VendingMachineAstroVend"/>
<GuideEntityEmbed Entity="VendingMachineAmmo"/>
<GuideEntityEmbed Entity="MachineCryoSleepPod"/>
</Box>
Some provisions (e.g. air tanks, salvage equipment) are available from vendors on Frontier Outpost, but most amenities (medical services, food) should be offered by players on shuttles or at the Trade Depot.

Frontier stations typically run longer shifts, so if you need to end early or take a break for a while, you can always return to a [color=##33bbff]Cryopod[/color] early.
Be sure to stock up at the Trade Depot if going out on an extended voyage, and take advantage of the [color=#33bbff]medical insurance tracker[/color] in your loadout, or from the NanoMed vendor in medbay.

Shifts on the Frontier typically last for [color=#33bbff]six hours[/color].
If you need to end your shift early or take a break, use the [color=#33bbff]cryo sleep chambers[/color] in the medbay on Frontier Outpost.
</Document>
35 changes: 35 additions & 0 deletions Resources/ServerInfo/_NF/Guidebook/Piloting.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<Document>
# Piloting
<Box>
<GuideEntityEmbed Entity="ComputerShuttle"/>
</Box>
To move a shuttle, you first need to click on the [color=#a4885c]shuttle console[/color] in its cockpit. After clicking the shuttle console, you should see a radar view of the space around your shuttle.

Newly purchased shuttles start docked with Frontier Outpost. To undock, follow these steps:

- Tell people you are undocking using the traffic radio channel (:d). Include your ship's callsign, which can be found on the NAV screen (e.g. "Pioneer NX-123 undocking.")
- Click on the DOCK tab, disconnect any airlocks that are docked to the station.
- Return to the NAV tab.

- To move a shuttle, the default controls (for a QWERTY keyboard) are:

-[color=#028ed9]W & S[/color]: Move forward and backward.
-[color=#028ed9]A & D[/color]: Move left and right.
-[color=#028ed9]Q & E[/color]: Rotate left and right.
-[color=#028ed9]Spacebar[/color]: Slow down.
-[color=#028ed9]Hold Spacebar + any input[/color]: Move and rotate slowly.

# Docking
<Box>
<GuideEntityEmbed Entity="AirlockGlassShuttle"/>
</Box>
[bold]Before docking your ship with:[/bold]
- [bold]Another ship[/color][/bold], it is best practice to announce your intention to dock over the traffic channel (:d).
- [bold][color=#ffd700]Frontier Outpost[/color][/bold], stop 200m out, request permission to dock from the Station Traffic Controller (STC) over the traffic radio channel (:d).
- [bold][color=#ffa500]Another station[/color][/bold], docks are first come, first serve. Be courteous and leave space where possible.

To dock the ship:
- Pilot towards the target so a set of its airlocks are nearby a set of airlocks of the target.
- When very close, click on the DOCK tab for a closer view.
- When next to the airlock, you can click "Dock" when highlighted to attach to the target.
</Document>
Loading
Loading