From: Nemanja <98561806+EmoGarbage404@users.noreply.github.com>
Date: Sun, 9 Jun 2024 18:02:35 +0000 (-0400)
Subject: Redo new player & controls guidebooks (#28794)
X-Git-Url: https://git.smokeofanarchy.ru/gitweb.cgi?a=commitdiff_plain;h=1490fc36d3be1bbc49c854e3d79d6399e63a1160;p=space-station-14.git
Redo new player & controls guidebooks (#28794)
---
diff --git a/Resources/Locale/en-US/guidebook/guides.ftl b/Resources/Locale/en-US/guidebook/guides.ftl
index 4bef8970b4..dcd5ee04b6 100644
--- a/Resources/Locale/en-US/guidebook/guides.ftl
+++ b/Resources/Locale/en-US/guidebook/guides.ftl
@@ -50,7 +50,7 @@ guide-entry-command = Command
guide-entry-service = Service
guide-entry-newplayer = New? Start here!
-guide-entry-charactercreation = Character Creation
+guide-entry-charactercreation = Creating Characters
guide-entry-species = Species
guide-entry-yourfirstcharacter = Your First Character
guide-entry-controls = Controls
diff --git a/Resources/ServerInfo/Guidebook/NewPlayer/Controls/Controls.xml b/Resources/ServerInfo/Guidebook/NewPlayer/Controls/Controls.xml
index 94cd325b86..72a3d63c6f 100644
--- a/Resources/ServerInfo/Guidebook/NewPlayer/Controls/Controls.xml
+++ b/Resources/ServerInfo/Guidebook/NewPlayer/Controls/Controls.xml
@@ -1,48 +1,62 @@
# Controls
-You can change the keybinds at any time here:
+You can change your keybinds at any time here:
-## Basic controls
-We shall politely assume you already know how WASD to walk works.
-Beyond that, there's a handful primary interactions in SS14, ordered by importance:
+## Movement
+You can move around the game world by using [color=yellow][bold][keybind="MoveUp"][keybind="MoveLeft"][keybind="MoveDown"][keybind="MoveRight"][/bold][/color].
+When holding down [color=yellow][bold][keybind="Walk"][/bold][/color], you'll walk, stopping you from slipping on the ground.
-- [color=#a4885c][keybind="Use"/][/color] to pick up items and activate objects like buttons or computers, and [color=#a4885c][keybind="ActivateItemInWorld"/][/color] to activate items. You can also press [color=#a4885c]alt[/color] while doing this to trigger alternate interactions for some objects.
-- You can also quickly activate items you're holding by pressing [color=#a4885c][keybind="ActivateItemInHand"/][/color] and [color=#a4885c][keybind="AltActivateItemInHand"/][/color] respectively.
-- [color=#a4885c][keybind="UIRightClick"/][/color] to open the context menu. You can then either left click an entry just like you would in the world, or right click it again to open the verb menu, which gives you more complex ways to interact with an object.
-- You can [color=#a4885c][keybind="ExamineEntity"/][/color] objects to examine them, and get their name and a detailed (though often humorous) description.
+You can switch walking to a [color=cyan]toggle[/color] in the controls menu.
-You can quickly try out these controls with the monkey below (note: clicking it only works in-game and not in the lobby), and at any point in this guidebook if you're shown an entity, [color=#a4885c][keybind="ExamineEntity"/] to examine will always work[/color]:
+[color=cyan]Pulling[/color] objects is done with [color=yellow][bold][keybind="TryPullObject"][/bold][/color].
+While pulling, you can drag an object to your mouse cursor using [color=yellow][bold][keybind="MovePulledObject"][/bold][/color].
+Pressing [color=yellow][bold][keybind="ReleasePulledObject"][/bold][/color] releases the item you are currently dragging.
+You may find yourself in a situation with [color=#EB2D3A][bold]low gravity.[/bold][/color]
+This will cause your character to drift around when moving.
+When off-station, you will be unable to control your direction.
+[bold]Throwing objects[/bold] or [bold]spraying a fire-extinguisher[/bold] can help propel yourself while in this state.
-
+## Interactions
+General interactions are done with [color=yellow][bold][keybind="Use"][/bold][/color].
+These are [bold]context-sensitive[/bold] and are affected by the item in your active hand.
+You can also use [color=yellow][bold][keybind="AltActivateItemInWorld"][/bold][/color] to perform [bold]alternate interactions[/bold].
-## Inventory
-In order to move items around in your inventory and between containers, you can click the item (or item name) to move it to your active hand, and then click the spot you want it to go (either a slot in your HUD, or the container).
+To perform [color=cyan]basic interactions[/color], use [color=yellow][bold][keybind="ActivateItemInWorld"][/bold][/color].
+This is like [bold]interacting with nothing in hand[/bold].
+Pressing [color=yellow][bold][keybind="ActivateItemInHand"][/bold][/color] has the same effect with the currently held item.
+It's most used for performing basic interaction while holding something, such as opening a door when your hands are full.
+
+Hovering over an entity and pressing [color=yellow][bold][keybind="UIRightClick"/][/bold][/color] brings up the [color=cyan]context menu[/color].
+This not only allows you to sort through large piles of items, but also to perform [bold]additional interactions.[/bold]
-The items in your hands are only active one at a time, in order to swap between what you're currently using, you can press [color=#a4885c][keybind="SwapHands"/][/color] on your keyboard to change active hands.
+[color=cyan]Examining[/color] things is done with [color=yellow][bold][keybind="ExamineEntity"][/bold][/color], which brings up a window with the object's name, a small description, and any other relevant details.
+[italic]Examining things around you can help you learn what they do and what properties they have[/italic].
-Opening containers in your inventory is easy as well, either hover over the item and activate it with [color=#a4885c][keybind="ActivateItemInWorld"/][/color] or click on the bag icon in the bottom right corner of the slot it is in.
+## Hands
+Using [color=yellow][bold][keybind="Use"][/bold][/color] on items in the world will pick them up and put them into your active hand.
+You can swap which hand is currently active using [color=yellow][bold][keybind="SwapHands"][/bold][/color].
-When you open a container a window will pop up showing the contents of the container and how much space it has available to hold things.
-All items have an assigned size, some too large to fit into most or all containers.
+You can [color=cyan]drop[/color] the item you are holding using [color=yellow][bold][keybind="Drop"][/bold][/color] or alternatively [color=cyan]throw it[/color] to your cursor with [color=yellow][bold][keybind="ThrowItemInHand"][/bold][/color].
-To drop items, you can press [color=#a4885c][keybind="Drop"/][/color], and to drop them more violently (also known as throwing), you can press [color=#a4885c][keybind="ThrowItemInHand"/][/color].
+## Inventory
+You can [color=cyan]open[/color] you inventory using [color=yellow][bold][keybind="OpenInventoryMenu"][/bold][/color].
+Each slot on your HUD can be filled with an appropriate [bold]item[/bold] or [bold]piece of clothing[/bold].
-A slightly advanced way to manage your inventory is to use [color=#a4885c]Shift + B[/color]. If your active hand is currently empty, this hotkey will pull out the latest item that was put in your bag. If you have an item in your hand - samek hotkey will put said item into your bag.
-Hotkey [color=#a4885c]Shift + E[/color] works exactly the same, but uses your belt as storage.
-## Actions
-To the left in your HUD there's a bar showing various actions you can take.
-You can hover over each one to see a name and description for the action that tells you what it is and how it works.
-You can click on an action to invoke it, or press a number key at any time to invoke the action without clicking on it.
+Two of the slots on the hotbar correspond to your [bold]bag and belt[/bold].
+You can open them using [color=yellow][bold][keybind="ActivateItemInWorld"][/bold][/color] on them or by clicking the icon in the [bold]bottom-right[/bold].
-In order to rearrange your actions, simply drag and drop them to other slots, right click to remove them, and press the gear icon at the top of the bar to open a menu to (re)add them.
-You have 10 pages of actions total that you can switch between by pressing [color=#a4885c]shift-(number)[/color].
-Additionally, you can press the lock icon to prevent the action bar from being modified.
+Pressing [color=yellow][bold][keybind="MoveStoredItem"][/bold][/color] will [color=cyan]take an item out[/color] of the bag.
+Holding it down will let you [color=cyan]drag[/color] the item to a different spot.
+While dragging, pressing [color=yellow][bold][keybind="RotateStoredItem"][/bold][/color] will [color=cyan]rotate[/color] the item.
-## Movement
-There's a good few things that can modify your movement, most notably slipping (which requires you to walk with [color=#a4885c]shift[/color] to avoid, usually.) and a lack of gravity.
-Slipping simply stuns you for a bit, but no gravity can be deadly if you're off station and wander more than about 1.5m away from the nearest wall or solid structure, as you'll lose your grip and no longer be able to move without throwing something.
+You can still do all regular interactions with items in your bag, including [color=cyan]examining[/color] and opening the [color=cyan]context menu[/color].
+
+## Camera
+The camera can [color=cyan]zoom[/color] in and out with [color=yellow][bold][keybind="ZoomIn"][/bold][/color] and [color=yellow][bold][keybind="ZoomOut"][/bold][/color] and can be reset with [color=yellow][bold][keybind="ResetZoom"][/bold][/color].
+Similarly, you can [color=cyan]rotate[/color] it left and right with [color=yellow][bold][keybind="CameraRotateLeft"][/bold][/color] and [color=yellow][bold][keybind="CameraRotateRight"][/bold][/color].
+You can recenter it to the grid's rotation using [color=yellow][bold][keybind="CameraReset"][/bold][/color].
diff --git a/Resources/ServerInfo/Guidebook/NewPlayer/NewPlayer.xml b/Resources/ServerInfo/Guidebook/NewPlayer/NewPlayer.xml
index 303230593b..50a102beff 100644
--- a/Resources/ServerInfo/Guidebook/NewPlayer/NewPlayer.xml
+++ b/Resources/ServerInfo/Guidebook/NewPlayer/NewPlayer.xml
@@ -1,28 +1,42 @@
-# Welcome!
+# Welcome to Space Station 14!
-Welcome to the alpha build of Space Station 14!
-You have just started your shift aboard a Nanotrasen space station. You and your crewmates should cooperate, perform your jobs the best you can and have fun.
+You've just begun your shift aboard a Nanotrasen space station.
+You and your fellow crewmates are tasked with working together, surviving, and having fun!
-We hope you enjoy the game, and this entry will serve to guide you on how to learn to play.
+[bold]Make sure to follow all server rules.[/bold] You can ask questions or report rule breaks to the [color=#EB2D3A][bold]admin team[/bold][/color] by using the [bold]admin help menu[/bold]. ([italic]accessible by pressing [/italic][color=yellow][bold][keybind="OpenAHelp"/][/bold][/color])
-There's quite a bit to read, but SS14 is in itself a very large and in-depth game, and hopefully these guides help you enjoy it to its fullest.
+More detailed guides about [italic]specific jobs[/italic] and [italic]mechanics[/italic] can be found [textlink="here." link="SS14"/]
-This entry and its subentries contain simple and broad information new players need to play the game on most servers.
+This guide can be reopened at any time using [color=yellow][bold][keybind="OpenGuidebook"][/bold][/color].
-Some information given here may be repeated or further touched upon in the Station and Shifts entry, [textlink="which can be found here." link="SS14"]
+## Basic Controls
+The following are the controls you'll need for regular gameplay:
-## How to use this guidebook
-This guidebook contains [color=#a4885c]step-by-step instructions[/color] on how to perform tasks, [color=#a4885c]tables of components[/color] one might require,
-or simply [color=#a4885c]tips, tricks and guidelines[/color] on how to perform your job.
+- Run using [color=yellow][bold][keybind="MoveUp"][keybind="MoveLeft"][keybind="MoveDown"][keybind="MoveRight"][/bold][/color]. Hold down [color=yellow][bold][keybind="Walk"][/bold][/color] to walk
-You can refresh yourself on your job before starting your shift or reference certain pages as needed, [textlink="such as recipes for cocktails" link="Drinks"].
+- Examine the world around you with [color=yellow][bold][keybind="ExamineEntity"][/bold][/color]
-## Wait, what's Space Station 14?
-Space Station 14 is a free (forever) open source remake of the infamous Space Station 13, hoping to provide an improved experience for both newcomers and old players alike. Space Station 14 is designed as a fully moddable experience that you can modify to your liking with custom servers, adding entire swaths of new content for people to explore.
+- Interact with the world using [color=yellow][bold][keybind="Use"][/bold][/color]
-Please make sure you understand the server rules (F1) and if you have any questions, consult this guide, your colleagues on shift in person or over radio or via discord. You can also ask admins for help (ahelp) by hitting the escape key > admin help and typing a message to any online admins. Especially do this if you witness someone breaking rules.
+- Hovering over an entity and pressing [color=yellow][bold][keybind="UseSecondary"][/bold][/color] shows the [italic]context menu[/italic], which contains additional interactions
-[color=#a4885c]To reiterate, you are all a crew of people who work together[/color] and you should not be harming each other unless you have an extremely good reason (such as self-defence) and even then, you should call security over radio.
+- Swap hands using [color=yellow][bold][keybind="SwapHands"][/bold][/color] and activate the currently held item with [color=yellow][bold][keybind="ActivateItemInHand"][/bold][/color]
+
+- Drop held items with [color=yellow][bold][keybind="Drop"][/bold][/color] or throw them using [color=yellow][bold][keybind="ThrowItemInHand"][/bold][/color]
+
+- Pull and release things with [color=yellow][bold][keybind="TryPullObject"][/bold][/color] and [color=yellow][bold][keybind="ReleasePulledObject"][/bold][/color]
+
+A more comprehensive list can be found on the [textlink="controls" link="Controls"] page.
+
+## What is SS14?
+Space Station 14 is a multiplayer game about paranoia and chaos on a space station and a remake of the cult-classic Space Station 13.
+
+Join dozens of other players on an intricately designed and simulated space station, immersing yourself in roleplay and dealing with threats along the way.
+
+SS14 is an [italic]open-source game[/italic] developed by people [bold]just like you![/bold]
+It receives [color=lime]daily updates[/color] and may at times be [color=#EB2D3A][bold]unstable.[/bold][/color]
+
+[italic]If you want to report bugs or help with development, join the discord and learn how to get started.[/italic]