Skip to content

Commit 43846e3

Browse files
committed
Update README.md
1 parent 075be41 commit 43846e3

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@
44

55
[Multi Theft Auto](https://www.multitheftauto.com/) (MTA) is a software project that adds network play functionality to Rockstar North's Grand Theft Auto game series, in which this functionality is not originally found. It is a unique modification that incorporates an extendable network play element into a proprietary commercial single-player PC game.
66

7-
> **Note**
8-
> If you're a fork developer, please read this note carefully. We have changed the default build type back to *CUSTOM* in `Shared/sdk/version.h`. If you're developing without the anti-cheat in mind, say in the Debug configuration, this doesn't affect you at all. Now, if you plan to test your custom client with anti-cheat enabled, you should change your build type to `UNTESTED`. If you want to publish a release of your custom client, you must switch to a *fork support* hardened release of `netc.dll`.
9-
> Please read our [Forks_Full_AC](https://wiki.multitheftauto.com/wiki/Forks_Full_AC) wiki page for more information.
10-
117
## Introduction
128

139
Multi Theft Auto is based on code injection and hooking techniques whereby the game is manipulated without altering any original files supplied with the game. The software functions as a game engine that installs itself as an extension of the original game, adding core functionality such as networking and GUI rendering while exposing the original game's engine functionality through a scripting language.
@@ -58,13 +54,10 @@ You can build the MTA:SA server on GNU/Linux distributions only for x86, x86_64,
5854

5955
**Build dependencies**
6056

61-
*Please always read the Dockerfiles for up-to-date build dependencies.*
62-
*Note: ncftp is not required for building the MTA:SA server.*
57+
*Please always read the utils/docker/Dockerfile for up-to-date build dependencies.*
6358

64-
- git
6559
- make
6660
- GNU GCC compiler (version 10 or newer)
67-
- libncursesw6
6861
- libncurses-dev
6962
- libmysqlclient-dev
7063

@@ -73,15 +66,17 @@ You can build the MTA:SA server on GNU/Linux distributions only for x86, x86_64,
7366
**Note:** This script always deletes `Build/` and `Bin/` directories and does a clean build.
7467

7568
```sh
76-
$ ./linux-build.sh [--arch=x86|x64|arm|arm64] [--config=debug|release]
69+
$ ./linux-build.sh [--arch=x86|x64|arm|arm64] [--config=debug|release] [--cores=<n>]
7770
$ ./linux-install-data.sh # optional step
7871
```
7972

8073
If build architecture `--arch` is not provided, then it's taken from the environment variable `BUILD_ARCHITECTURE` (defaults to: x64).
8174

8275
If build configuration `--config` is not provided, then it's taken from the environment variable `BUILD_CONFIG` (defaults to: release).
8376

84-
If you are trying to **cross-compile** to another architecture, then set `AR`, `CC`, `CXX`, `GCC_PREFIX` environment variables accordingly (see Dockerfile.arm64 for an example).
77+
If the number of jobs `--cores` is not provided, then the build will default to the amount of CPU cores.
78+
79+
If you are trying to **cross-compile** to another architecture, then set `AR`, `CC`, `CXX`, `GCC_PREFIX` environment variables accordingly (see `utils/docker/Dockerfile` for an example).
8580

8681
**Build instructions: Manual**
8782

@@ -107,12 +102,19 @@ $ docker pull ghcr.io/multitheftauto/mtasa-blue-build:latest
107102

108103
These examples assume that your current directory is the mtasa-blue checkout directory. You should also know that `/build` is the code directory required by our Docker image inside the container. After compiling, you will find the resulting binaries in `./Bin`. To build the unoptimised debug build, add `--config=debug` to the docker run arguments.
109104

110-
| Architecture | Build command |
111-
| ------------ | --------------------------------------------------------------------------------------------------- |
112-
| x86_64 | ``` docker run --rm -v `pwd`:/build ghcr.io/multitheftauto/mtasa-blue-build:latest --arch=x64 ``` |
113-
| x86 | ``` docker run --rm -v `pwd`:/build ghcr.io/multitheftauto/mtasa-blue-build:latest --arch=x86 ``` |
114-
| arm | ``` docker run --rm -v `pwd`:/build ghcr.io/multitheftauto/mtasa-blue-build:latest --arch=arm ``` |
115-
| arm64 | ``` docker run --rm -v `pwd`:/build ghcr.io/multitheftauto/mtasa-blue-build:latest --arch=arm64 ``` |
105+
```sh
106+
# x86_64
107+
docker run --rm -v `pwd`:/build ghcr.io/multitheftauto/mtasa-blue-build:latest --arch=x64
108+
109+
# x86
110+
docker run --rm -v `pwd`:/build ghcr.io/multitheftauto/mtasa-blue-build:latest --arch=x86
111+
112+
# arm
113+
docker run --rm -v `pwd`:/build ghcr.io/multitheftauto/mtasa-blue-build:latest --arch=arm
114+
115+
# arm64
116+
docker run --rm -v `pwd`:/build ghcr.io/multitheftauto/mtasa-blue-build:latest --arch=arm64
117+
```
116118

117119
### Premake FAQ
118120

0 commit comments

Comments
 (0)