Skip to content

Commit b570b37

Browse files
committed
Update README to show new launcher screen and art updating process
Signed-off-by: Stephen M. Cameron <stephenmcameron@gmail.com>
1 parent 3b3971d commit b570b37

11 files changed

+55
-40
lines changed

README.md

Lines changed: 55 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ Here's a quick preview of the build instructions detailed below:
5454

5555
0. Acquire necessary hardware (some linux machines, network switch, cables, projector, stereo, etc.)
5656
1. Clone git repository or obtain source tarball and unpack it.
57-
2. Install dependencies (run `util/install_dependencies` on apt-based systems)
57+
2. Install dependencies
5858
3. Build the code (type "`make`")
59-
4. Download additional art assets (type "`bin/snis_launcher`", then choose
60-
option 1, "Check for asset updates and set up assets".)
61-
5. Run the game (type "`bin/snis_launcher`")
59+
5. Run the game (type "`bin/snis_client`")
60+
6. Download additional art assets
61+
7. Restart `snis_client`
6262

6363

6464
[Here is a long, boring video demonstrating how to install](https://www.youtube.com/watch?v=tCokfUtZOqw)
@@ -159,7 +159,7 @@ performs its job satisfactorily, you can advance to Step 3.
159159
> #
160160
> sudo apt-get install libopus-dev; # used for voice-chat feature
161161
> sudo apt-get install libopus0; # used for voice-chat feature
162-
>
162+
>
163163
> # (The following are optional)
164164
> sudo apt-get install espeak; # optional alternative to libttspico-utils
165165
> sudo apt-get install alsa-utils; # optional alternative to sox, for "aplay" command
@@ -185,31 +185,6 @@ you will want the following packages:
185185
The above list may be incomplete, and these are the package names on mint 17.3 / ubuntu,
186186
so may be different on RPM based systems.
187187

188-
> NOTE: Later, the Makefile will download the Opus library source (
189-
> https://archive.mozilla.org/pub/opus/opus-1.3.1.tar.gz). This library is used
190-
> for the voice chat feature. If you intend to build on a machine which does not
191-
> have internet access, or for whatever reason do not want the makefile to download
192-
> this library at build time, you can download it yourself beforehand. Or you can
193-
> modify the Makefile and change "WITHVOICECHAT=yes" at the top of the file to
194-
> "WITHVOICECHAT=no" and it will not download this library (and you won't have the
195-
> voice chat feature.)
196-
197-
> NOTE: problems building on SuSE Leap 15.1. The following problems/solutions have
198-
> been conveyed to me regarding SuSE Leap 15.1. This information is not very complete or
199-
> accurate, but it is the best I have for now. Please feel free to send me
200-
> improvements to these instructions.
201-
> See [Bug 222](https://github.com/smcameron/space-nerds-in-space/issues/222)
202-
203-
204-
1. Need to install pkg-config and pkg-config_files.
205-
2. Need to set pkg-config-path environment variable
206-
3. All references to lua 5.2 in the Makefile need to be changed to lua 5.3.
207-
Note, we only compiled snis_client (via "make bin/snis_client") which shouldn't
208-
need lua at all. I don't know if the differences between lua 5.3 and lua 5.2 are
209-
significant enough to break things. I normally use lua 5.2 on my systems.
210-
[Changes to Lua 5.3](http://www.lua.org/manual/5.3/readme.html#changes)
211-
-- at a quick glance I didn't see anything that I think will be problematic.
212-
213188
## Step 3: Build the Code
214189

215190
To build the code, make sure you are in the top level
@@ -271,18 +246,58 @@ requires the additional step of running:
271246

272247
to copy assets into ~/.local/share/space-nerds-in-space.
273248

274-
## Step 5: Download additional assets
275-
276-
If you skipped step 4 and didn't build the openscad models, they will be downloaded
277-
in this step, along with some other things. This step requires an internet connection.
278-
If you performed step 4, you may skip this step though it is not recommended,
279-
as you will be missing some additional solarsystem assets. As a non-root user:
249+
## Step 5: Run the game
280250

281251
```
282-
> bin/snis_launcher
252+
> bin/snis_client
283253
```
284254

285-
Then choose option 1, "Check for asset updates and set up assets". This will copy assets
286-
to (by default) into $HOME/.local/share/space-nerds-in-space/ and download additional assets
287-
over the internet.
255+
You should see something like this:
256+
257+
![SNIS Client complains about missing assets](doc/images/missing-assets.png)
258+
259+
There are art assets not included in the source code. Click the UPDATE ASSETS
260+
button to fetch the assets.
261+
262+
![SNIS Client fetching assets](doc/images/downloading-assets.png)
263+
264+
After a few minutes, the assets will finish downloading. Then you can press the
265+
RESTART SNIS CLIENT button to use the newly acquired assets.
266+
267+
![Restart SNIS Client](doc/images/restart-snis-client.png)
268+
269+
Next, start the game servers (`snis_server`, `snis_multiverse`, and `ssgl_server`) by
270+
clicking the START SERVERS button.
271+
272+
![Start SNIS server processes](doc/images/start-servers.png)
273+
274+
Next, connect to the lobby.
275+
276+
![Connect to the lobby](doc/images/connect-client.png)
277+
278+
Here is the Network Setup screen. Choose your ship name and password, and check
279+
the MAIN SCREEN role, then click the ENTER LOBBY LOCALHOST button.
280+
281+
![Network Setup screen](doc/images/network-setup.png)
282+
283+
Now you will see the lobby screen, with a single snis server running. Click on this and
284+
the CONNECT TO SERVER button.
285+
286+
![SNIS Lobby](doc/images/lobby.png)
287+
288+
Finally, you are playing the game. First you will see the MAIN VIEW -- the view out of
289+
the window of your spacecraft.
290+
291+
![MAIN VIEW](doc/images/main-view.png)
292+
293+
In your brand new spacecraft, nothing is turned on. Press F4 to go to the ENGINEERING screen,
294+
then click on the '1' to activate the first preset which gives power and coolant to all the
295+
ship's systems.
296+
297+
![ENGINEERING](doc/images/engineering.png)
298+
299+
Press F2 to go to NAVIGATION. In the upper right corner of the screen is a vertical
300+
slider that controls the thrusters of your ship. Click on it to begin moving forward.
301+
302+
![NAVIGATION](doc/images/navigation.png)
288303

doc/images/connect-client.png

122 KB
Loading

doc/images/downloading-assets.png

40.2 KB
Loading

doc/images/engineering.png

49.2 KB
Loading

doc/images/lobby.png

132 KB
Loading

doc/images/main-view.png

60.2 KB
Loading

doc/images/missing-assets.png

33 KB
Loading

doc/images/navigation.png

75.5 KB
Loading

doc/images/network-setup.png

115 KB
Loading

doc/images/restart-snis-client.png

39.2 KB
Loading

doc/images/start-servers.png

124 KB
Loading

0 commit comments

Comments
 (0)