Skip to content

Commit

Permalink
Factor out help text
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen M. Cameron <stephenmcameron@gmail.com>
  • Loading branch information
smcameron committed Oct 13, 2023
1 parent 6059706 commit c9bd8de
Show file tree
Hide file tree
Showing 11 changed files with 236 additions and 199 deletions.
18 changes: 18 additions & 0 deletions help_text_comms_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

/* This is C code, not plain text */

/* 5 - Comms help text */
"COMMUNICATIONS\n\n"
" ENTER TEXT TO TRANSMIT ON CURRENT CHANNEL\n\n"
FKEYS_HELP_TEXT
" CONTROLS\n"
" * ZOOM CONTROLS MAIN SCREEN ZOOM\n"
" * RED ALERT SOUNDS RED ALERT ALARM\n"
" * TOP ROW OF BUTTONS CONTROLS MAIN SCREEN\n\n"
" COMMANDS\n"
" * COMMANDS ARE PRECEDED BY FORWARD SLASH -> /\n"
" * /help\n"
" * /channel channel-number - change current channel\n"
" * /computer <english request for computer>\n"
" * /hail ship-name - hail ship on current channel\n"
ESC_OR_F1_HELP_TEXT,
13 changes: 13 additions & 0 deletions help_text_damage_control_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

/* This is C code, not plain text. */

/* 7 - Damage control help text */
"DAMAGE CONTROL HELP\n"
FKEYS_HELP_TEXT
" * MANUAL CONTROL\n"
" * SELECT MANUAL THEN USE ARROW KEYS TO CONTROL ROBOT\n"
" * USE SPACE BAR TO PICK UP AND REPAIR OR DROP MODULES\n"
" * USE REPAIR STATION TO REPAIR BADLY DAMAGED MODULES\n"
" * AUTOMATIC CONTROL\n"
" * SELECT AUTO TO ALLOW THE ROBOT TO CONTROL ITSELF\n"
ESC_OR_F1_HELP_TEXT,
22 changes: 22 additions & 0 deletions help_text_demon_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

/* This is C code, not plain text. */

/* 6 - Demon screen help text */
"DEMON SCREEN HELP\n\n"
FKEYS_HELP_TEXT
"THE DEMON, (AKA GAMEMASTER) SCREEN ALLOWS A\n"
"USER TO MANIPULATE THE GAME UNIVERSE\n\n"
"* USE THE MOUSE WHEEL TO ZOOM IN AND OUT\n"
"* SELECT BUTTONS ON LEFT SIDE OF SCREEN AND\n"
" USE LEFT MOUSE BUTTON TO ADD NEW ITEMS\n"
"* UNSELECT BUTTONS ON LEFT SIDE OF SCREEN AND\n"
" USE OR DRAG RIGHT MOUSE BUTTON TO SELECT ITEMS\n"
"* USE MIDDLE MOUSE BUTTON TO MOVE SELECTED ITEMS\n"
"* USE TEXT BOX TO ENTER COMMANDS\n"
"* USE \"SELECT NONE\" BUTTON TO DE-SELECT ITEMS\n"
"* USE \"CAPTAIN\" BUTTON TO TAKE CONTROL OF SHIPS\n"
" USE ARROW KEYS TO CONTROL \"CAPTAINED\" SHIPS\n"
" USE PHASER AND TORPEDO BUTTONS WHILE\n"
" \"CAPTAINING SHIPS.\n"
"* USE \"HELP\" COMMAND IN TEXT BOX FOR MORE INFO\n"
ESC_OR_F1_HELP_TEXT,
19 changes: 19 additions & 0 deletions help_text_engineering_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

/* This is C code, not plain text. */

/* 3 - Engineering help text */
"ENGINEERING HELP\n\n"
" CONTROLS\n\n"
FKEYS_HELP_TEXT
" * USE SLIDERS ON LEFT SIDE OF SCREEN\n"
" TO LIMIT POWER CONSUMPTION OF SHIP\n"
" SYSTEMS AND TO ALLOCATE COOLANT\n"
" * HEALTH AND TEMPERATURE OF SYSTEMS\n"
" IS INDICATED ON RIGHT SIDE OF SCREEN\n"
" * OVERHEATING SYSTEMS FLASH RED AND\n"
" CAUSE DAMAGE TO THEMSELVES\n"
" * 1 AND 2 BUTTONS ARE PRESETS\n"
" * LIFE SUPPORT SYSTEM PRODUCES OXYGEN\n"
" * IF OXYGEN LEVELS REACH ZERO, CREW ASPHYXIATES\n"
" * IF SHIELDS ARE DESTROYED, SHIP IS DESTROYED\n"
ESC_OR_F1_HELP_TEXT,
12 changes: 12 additions & 0 deletions help_text_lobby_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

/* This is C code, not plain text. */

/* 10 - Lobby screen */
"\nLOBBY SCREEN HELP\n\n"
" * 1. CLICK ON THE SERVER YOU WISH TO CONNECT TO.\n\n"
" 2. ONCE YOU SELECT A SERVER, A CONNECT BUTTON\n"
" WILL APPEAR NEXT TO IT. CLICK ON THIS CONNECT\n"
" BUTTON TO CONNECT TO THE SERVER.\n\n"
" * CLICK ON THE CANCEL BUTTON TO RETURN TO\n"
" THE NETWORK SETUP SCREEN.\n\n"
ESC_OR_F1_HELP_TEXT,
17 changes: 17 additions & 0 deletions help_text_main_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

/* This is C code, not plain text. */

/* 0 - Main screen help text */
"MAIN SCREEN HELP\n\n"
" CONTROLS\n\n"
FKEYS_HELP_TEXT
" * USE ARROW KEYS TO TURN SHIP\n"
" * AWSD and QE KEYS ALSO WORK\n\n"
" * SHIFT-W KEY TOGGLES BETWEEN WEAPONS VIEW\n"
" AND MAIN VIEW\n\n"
" * BACKQUOTE KEY CYCLES THROUGH CAMERA VIEW MODES\n"
" * CTRL-I INVERTS VERTICAL KEYBOARD CONTROLS\n"
" * 'f' TOGGLES SPACE DUST EFFECT\n"
" * CTRL-C TOGGLES CREDITS SCREEN\n"
" * CTRL-R CYCLES RENDER MODES (FOR DEBUGGING ONLY)\n"
ESC_OR_F1_HELP_TEXT,
30 changes: 30 additions & 0 deletions help_text_nav_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

/* This is C code, not plain text. */

/* 1 - Navigation help text */
"NAVIGATION HELP\n\n"
" CONTROLS\n\n"
FKEYS_HELP_TEXT
" * YAW: LEFT/RIGHT ARROW KEYS, A/D KEYS, OR USE MOUSE WHEEL\n"
" * PITCH: UP/DOWN ARROW KEYS, W/S KEYS (CTRL-I INVERTS CONTROLS)\n"
" * ROLL: Q/E KEYS\n"
" * AWSD KEYS ALSO WORK\n"
" * USE THROTTLE SLIDER TO SET THROTTLE\n"
" * R BUTTON ABOVE THROTTLE REVERSES THRUST\n"
" * USE WARP FOR FAST TRAVEL\n"
" * USE PLUS/MINUS KEYS TO ZOOM VIEW\n"
" * USE BACKQUOTE KEY TO CYCLE CAMERA POSITION\n"
" * CTRL-I INVERTS VERTICAL KEYBOARD CONTROLS\n"
" * USE STANDARD ORBIT TO ORBIT NEARBY PLANET\n"
" * STAR MAP INDICATES WARP GATE-REACHABLE STARS\n"
" * TO DOCK: HAVE COMMS HAIL STARBASE AND\n"
" REQUEST PERMISSION TO DOCK. YOU MUST BE\n"
" NEARBY WITH SHIELDS LOWERED. WITH PERMISSION\n"
" GRANTED, ENGAGE DOCKING MAGNETS AND APPROACH\n"
" DOCKING PORTS. PERMISSION WINDOW IS 3 MINUTES.\n"
" * TO UNDOCK, DISENGAGE DOCKING MAGNETS.\n"
" DOCKING PERMISSION IS REVOKED UPON UNDOCKING\n"
" AND MUST BE REQUESTED AGAIN TO RE-DOCK.\n\n"
" GREEN ARROW INDICATES DIRECTION OF SCIENCE SELECTION.\n\n"
" CYAN ARROW INDICATES DIRECTION WEAPONS ARE AIMED.\n\n"
ESC_OR_F1_HELP_TEXT,
39 changes: 39 additions & 0 deletions help_text_network_setup_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

/* This is C code, not plain text. */

/* 13 - Network Setup screen */
"\nNETWORK SETUP SCREEN HELP\n\n"
"* LOBBY SERVER NAME OR IP ADDRESS\n"
" ENTER THE HOST NAME OR IP ADDRESS OF THE COMPUTER\n"
" RUNNING THE LOBBY PROCESS. IF YOU ARE RUNNING THE\n"
" LOBBY PROCESS ON THIS COMPUTER, ENTER localhost\n"
"* START LOBBY SERVER"
" ONLY CLICK THIS BUTTON IF YOU WANT TO START THE\n"
" LOBBY SERVER ON THIS HOST AND HAVE NOT ALREADY\n"
" STARTED IT IT. IF YOU USED A SCRIPT LIKE QUICKSTART\n"
" OR SNIS_LAUNCHER, YOU DO NOT NEED TO CLICK THIS\n"
"* GAME SERVER NICKNAME\n"
" ENTER WHATVER YOU LIKE FOR A SERVER NICKNAME HERE\n"
" THIS ONLY HAS AN EFFECT IF YOU START A GAME SERVER\n"
" USING THE START GAME SERVER BUTTON\n"
" ORDINARILY YOU WOULD INSTEAD START A GAME SERVER\n"
" USING THE SNIS_LAUNCHER SCRIPT\n"
"* START GAME SERVER\n"
" USE THIS TO START A GAME SERVER. NORMALLY YOU\n"
" DO NOT NEED TO USE THIS, INSTEAD START A GAME\n"
" SERVER USING THE SNIS_LAUNCHER OR QUICKSTART SCRIPT\n"
"* CREATE SHIP\n"
" SELECT THIS IF YOU WISH TO CREATE A NEW SHIP\n"
" IF YOU HAVE ALREADY CREATED A SHIP WITH A PARTICULAR NAME\n"
" DO NOT TRY TO CREATE THE SAME SHIP MORE THAN ONCE\n"
"* JOIN SHIP\n"
" IF OTHER PLAYERS ARE ALREADY ABOARD THE SHIP, SELECT\n"
" JOIN SHIP. IF YOU ARE THE FIRST PLAYER ABOARD, DO NOT\n"
" SELECT JOIN SHIP.\n"
"* ROLES\n"
" SELECT THE ROLES (STATIONS) YOU WISH YOUR COMPUTER TO ACT AS.\n"
"* SHIP NAME AND PASSWORD\n"
" ENTER THE NAME OF YOUR SHIP AND PASSWORD FOR YOUR SHIP\n"
"* CONNECT TO LOBBY\n"
" PRESS THE CONNECT TO LOBBY BUTTON TO CONNECT TO THE LOBBY\n"
ESC_OR_F1_HELP_TEXT,
25 changes: 25 additions & 0 deletions help_text_science_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

/* This is C code, not plain text. */

/* 4 - Science help text */
"SCIENCE HELP\n\n"
" CONTROLS\n\n"
FKEYS_HELP_TEXT
" * USE MOUSE WHEEL TO ZOOM/UNZOOM\n"
" * USE LEFT/RIGHT ARROWS TO ROTATE SCANNING BEAM (USE CTRL FOR FINE ADJUSTMENT)\n"
" * USE UP/DOWN ARROWS TO FOCUS/WIDEN SCANNING BEAM (USE CTRL FOR FINE ADJUSTMENT)\n"
" * SELECT TARGETS WITH MOUSE TO EXAMINE\n"
" USE DETAILS BUTTON FOR MORE INFO\n"
" * LRS LONG RANGE SCANNER\n"
" * PRESS AND HOLD RIGHT MOUSE BUTTON WITHIN VIEWSCREEN TO ROTATE VIEW\n"
" * OR USE COMMA, PERIOD, SLASH, L-KEY, K-KEY, SEMICOLON TO ROTATE VIEW\n"
" * USE CTRL KEY FOR FINE ADJUSTMENT\n"
" * SRS SHORT RANGE SCANNER\n"
" * MINING ROBOT\n"
" SELECT AN ASTEROID OR DERELICT SHIP THEN LAUNCH THE MINING ROBOT\n"
" COMMS MAY HAIL THE ROBOT TO FURTHER CONTROL ITS ACTIONS\n"
" * TRACTOR BEAM\n"
" SELECT A NEARBY TARGET AND ENGAGE THE TRACTOR BEAM TO DRAW\n"
" THE TARGET TOWARDS THE SHIP\n"
" * SET WAYPOINTS TO AID NAVIGATION\n"
ESC_OR_F1_HELP_TEXT,
20 changes: 20 additions & 0 deletions help_text_weapons_screen.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

/* This is C code, not plain text. */

/* 2 - Weapons help text */
"WEAPONS HELP\n\n"
" CONTROLS\n\n"
FKEYS_HELP_TEXT
" * USE ARROW KEYS OR MOUSE TO AIM WEAPONS\n"
" * AWSD KEYS ALSO WORK\n"
" * FIRE PHASERS WITH SPACE BAR OR LEFT MOUSE BUTTON\n"
" * FIRE TORPEDOES WITH Z OR RIGHT MOUSE BUTTON\n"
" * FIRE MISSILES WITH N (MUST AIM AT IN-RANGE TARGET)\n"
" * PLUS/MINUS KEYS SET PHASER WAVELENGTH\n"
" (OR USE MOUSE WHEEL)\n"
" * MATCH PHASER WAVELENGTH TO WEAKNESSES\n"
" IN ENEMY SHIELDS\n"
" * CTRL-I INVERTS VERTICAL KEYBOARD CONTROLS\n"
" * CTRL-M TOGGLE WEAPONS MOUSE BEHAVIOR\n"
" * CTRL-S TOGGLES SPACE DUST EFFECT\n"
ESC_OR_F1_HELP_TEXT,
Loading

0 comments on commit c9bd8de

Please sign in to comment.