Merge pull request #43 from iamthesenate1/readme.md

Fix some typos and rephrase some sentences in README.md
This commit is contained in:
ptitSeb 2021-09-11 18:39:20 +02:00 committed by GitHub
commit 8f1a2733d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -23,12 +23,12 @@ This is the source code for Serious Engine v.1.10, including the following proje
* `GameAgent` The serverlist masterserver written in Python * `GameAgent` The serverlist masterserver written in Python
* `libogg`, `libvorbis` Third party libraries used for playing OGG-encoded ingame music (see http://www.vorbis.com/ for more information) * `libogg`, `libvorbis` Third party libraries used for playing OGG-encoded ingame music (see http://www.vorbis.com/ for more information)
These have been modified to run correctly under the recent version of Windows. (Tested: Win7 x64, Win8 x64, Win8.1 x64) These have been modified to run correctly under recent versions of Windows. (Tested: Win7 x64, Win8 x64, Win8.1 x64)
Building Building
-------- --------
Note that DEBUG build will certainely not work. There are still many assert in the engine, most of them are irrelevent and should be removed, but while it's not done, the assert will effectively kiils the engine when triger in Debug build. Use Release or RelWithDebInfo build if you intend to play (automatically set as RelWithDebInfo in the build scripts) There are still many asserts in the engine. Most of them are irrelevant and should be removed, but while it's not done, the asserts will effectively kill the engine when triggered in the Debug build. Use Release or RelWithDebInfo build if you intend to play (automatically set as RelWithDebInfo in the build scripts).
### Windows ### Windows
@ -53,9 +53,9 @@ cd Serious-Engine
If you have access to a copy of the game (either by CD or through Steam), If you have access to a copy of the game (either by CD or through Steam),
you can copy the *.gro files from the game directory to the repository. you can copy the *.gro files from the game directory to the repository.
Not that for running SS:TFE, you don't need the ModEXT.txt file, it's only for SS:TSE. Note that for running SS:TFE, you don't need the ModEXT.txt file, it's only for SS:TSE.
Alternativelly, you can simply copy the whole content of the Windows install as base dir, add the `SE1_10.gro` from the repo in the root folder of the install, and then copy the binary built in `Bin` folder Alternatively, you can simply copy the whole content of the Windows install as base dir, add the `SE1_10.gro` from the repo in the root folder of the install, and then copy the binary built in `Bin` folder
#### Building (only for SS:TSE) #### Building (only for SS:TSE)
@ -77,7 +77,7 @@ cp Sources/cmake-build/ssam-tfe Bin/
cp Sources/cmake-build/Debug/* Bin/ cp Sources/cmake-build/Debug/* Bin/
``` ```
Note that the CD version of SS:TSE used MP3 for music. You will need to build / get `libamp11lib.so` and copy it inside `Bin` with the other libs to have music. Steam version is ogg and don't need this library. Note that the CD version of SS:TSE used MP3 for music. You will need to build / get `libamp11lib.so` and copy it inside `Bin` with the other libs to have music. Steam version uses ogg and doesn't need this library.
#### Running #### Running
@ -118,7 +118,6 @@ And its working directory:
Common problems Common problems
--------------- ---------------
Before starting the build process, make sure you have a "Temp" folder in your development directory. If it doesn't exist, create it.
SeriousSkaStudio has some issues with MFC windows that can prevent the main window from being displayed properly. SeriousSkaStudio has some issues with MFC windows that can prevent the main window from being displayed properly.
License License