diff --git a/README.md b/README.md index 11deb75d2f..e8fda4980d 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,21 @@ AssaultCube is a **FREE**, multiplayer, first-person shooter game, based on the [CUBE engine](http://cubeengine.com/cube.php). -Taking place in realistic environments, with fast, arcade gameplay, +Taking place in realistic environments, with fast and intense gameplay, it's addictive and fun! With efficient bandwidth usage, it's low-latency and can even run over a 56 Kbps connection. It's tiny too, weighing in at a lightweight about 50 MB package available for [Windows, Linux, Mac](https://assault.cubers.net/download.html). On the correct settings, it can even run on old hardware (Pentium III and above). +Recommended to run the insane graphics settings for modern machines. ![screenshot](https://user-images.githubusercontent.com/7680684/69888836-9a931d80-12b3-11ea-8123-bbf06908a96f.jpg) ## Features in a nutshell: * It's **FREE**. + * Basically CS 1.6 but open-source and moderately updated * Source code is available under a zlib-like open source license. * Low latency, it can even run across a 56 Kbps connection! * Lightweight size, only about 50 MB to download, plus additional maps @@ -32,8 +34,9 @@ On the correct settings, it can even run on old hardware (Pentium III and above) Capture the Flag, Hunt the Flag, Keep the Flag, Pistol Frenzy, Last Swiss Standing & One-Shot One-Kill (plus team versions of these modes). * Comes pre-packaged with several dozen different maps! + * Several weapon classes for unique gameplay or hardcore strategy! -## More info: +## Documentation: Most of this README was directly copied from the [AssaultCube Homepage](https://assault.cubers.net), which should have everything @@ -42,6 +45,7 @@ you need in relation to AssaultCube. ## Contributing: Learn [how to become a contributor and submit your own code](CONTRIBUTING.md) + * Submit any issues, suggestions, bugs or vulnerabilities you might have! ## Redistribution: diff --git a/check_install.sh b/check_install.sh index 19f22ed429..ad2eb6e8b6 100755 --- a/check_install.sh +++ b/check_install.sh @@ -1,7 +1,7 @@ #!/bin/sh -# Checks certain parts of an AssaultCube installation +# Checks certain parts of the AssaultCube installation # -# Try this, if your game does not start. +# Try this if your game doesn't start. # CUBE_DIR=$(dirname "$(readlink -f "${0}")") @@ -35,14 +35,14 @@ else fi echo "" -# check all files that belong to the installation +# check all files belonging to the installation # (use source/dev_tools/generate_md5_checksums.sh to generate a checksum file) CHKSUMFILE="packages/misc/checksums_md5.txt" if [ -e $CHKSUMFILE ]; then echo "checking installed game files:" if md5sum -c $CHKSUMFILE --status; then - echo " all files of the AC package are checked and OK" + echo " All AC package files are verified" else echo " some files of your AC installation appear to be missing or damaged" read -p " press enter, to see the list of files..." -r dummy @@ -65,7 +65,7 @@ else fi echo "" -# find out, which binaries would be used to start the game +# find out which binaries will be used to start the game echo "checking game executables:" SERVERBIN=`./server.sh --outputbinarypath` @@ -74,17 +74,17 @@ CLIENTBIN=`./assaultcube.sh --outputbinarypath` if [ -x "$SERVERBIN" ]; then echo " the server will use the binary $SERVERBIN" elif [ -e "$SERVERBIN" ]; then - echo " the server would use the binary $SERVERBIN, if the permissions would allow it" + echo " the server would use the binary $SERVERBIN, if the permissions allowed it" else - echo " the server would use the binary $SERVERBIN, but the file does not exist" + echo " the server would use the binary $SERVERBIN, but the file doesn't exist" fi if [ -x "$CLIENTBIN" ]; then echo " the game client will use the binary $CLIENTBIN" elif [ -e "$CLIENTBIN" ]; then - echo " the server would use the binary $CLIENTBIN, if the permissions would allow it" + echo " the server would use the binary $CLIENTBIN, if the permissions allowed it" else - echo " the server would use the binary $CLIENTBIN, but the file does not exist" + echo " the server would use the binary $CLIENTBIN, but the file doesn't exist" fi exit 0 diff --git a/server.sh b/server.sh index 65f80ef5ff..42f7e0f076 100755 --- a/server.sh +++ b/server.sh @@ -1,6 +1,6 @@ #!/bin/sh -# CUBE_DIR should refer to the directory in which AssaultCube is placed. +# CUBE_DIR refers to the AssaultCube directory path. #CUBE_DIR=~/assaultcube #CUBE_DIR=/usr/local/assaultcube CUBE_DIR=. @@ -12,11 +12,11 @@ CUBE_OPTIONS="" # If enabled, any options under CUBE_OPTIONS are superseded by options in servercmdline.txt CUBE_OPTIONFILE=-Cconfig/servercmdline.txt -# SYSTEM_NAME should be set to the name of your operating system. +# SYSTEM_NAME should be set to the name of your OS. #SYSTEM_NAME=Linux SYSTEM_NAME=`uname -s` -# MACHINE_NAME should be set to the architecture of your processor. +# MACHINE_NAME should be your processor architecture. #MACHINE_NAME=i686 MACHINE_NAME=`uname -m`