Skip to content

Commit 37d9ee9

Browse files
authored
Update README
Presentation is key.
1 parent b09b4a9 commit 37d9ee9

File tree

1 file changed

+11
-36
lines changed

1 file changed

+11
-36
lines changed

README.md

Lines changed: 11 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,27 @@
1-
Mod Loader
2-
=============================
1+
# Mod Loader
32

4-
Mod Loader is an ASI Plugin for Rockstar's Grand Theft Auto San Andreas that adds an extremely user-friendly and easy way to install and uninstall your modifications, without even messing around anything in your game installation.
3+
Mod Loader is a plugin for Grand Theft Auto III, Vice City and San Andreas that adds an easy and user-friendly way to install and uninstall modifications into the game, as if the game had official modding support. No changes are **ever** made to the original game files, everything is injected on the fly, at runtime!
54

6-
### Introduction
5+
The usage is as simple as inserting the mod files into the *modloader/* directory. Uninstalling is as easy as that too, delete the mod files and you are done. Hot swapping mods while the game is running? By using Mod Loader you can!
76

8-
Modifications are very popular in the Grand Theft Auto community, specially in Grand Theft Auto San Andreas, but everything is just too difficult to install since modding is not officially supported. People gets scared of how hard it is to install modifications.
7+
Still not sure? Check out [this](https://www.youtube.com/watch?v=TvRpQa8dJ7E) nice video from Ivey. For more, check out our [GTAForums](http://gtaforums.com/topic/669520-mod-loader/) thread and our [GTAGarage](http://www.gtagarage.com/mods/show.php?id=25377) page.
98

10-
This modification aims to provide a extremely simple way to install modifications as seen in games with official modding support, you just place the modification in the modloader folder and look, it is installed! Easier than that is impossible. Uninstalling is that simple too, just remove the modification from the modloader folder.
9+
### Building and Installing
1110

12-
An important note is that modloader **DO NOT** touch **ANY** file from your game installation, so no risks.
11+
Requirements:
1312

14-
It may be very helpful for people with two or more game installations for different kind of modifications (e.g. one install clean, one install to play multiplayer, one install for mods, one install for a total conversion...).
15-
16-
It certainlly is very helpful for developers, they don't have to be messing with *.img* files, rebuilding them everytime. And even better, you can reload the mods without getting out of the game!
17-
18-
This is a open source project, so, feel free to learn and contribute!
19-
20-
21-
### Compiling and Installing
22-
23-
If you are building from the source code, it is very simple to compile. You'll need the following:
24-
25-
+ [Premake](http://industriousone.com/premake/download) 5 *(pre-built executable available in this repository root)*
13+
+ [Premake 5](http://industriousone.com/premake/download) *(pre-built executable available in this repository root)*
2614
+ [Visual Studio](http://www.visualstudio.com/downloads) 2013 or greater.
2715

28-
Then, in a command-line shell go into the repository root directory and run the command:
16+
Run the following command in the root of this directory to generate the project files:
2917

30-
premake5 vs2013
18+
premake5 vs2013
3119

32-
then you can compile the generated project in the build directory.
33-
34-
After such, you can install the generated binaries into your game directory by running
20+
You can install the generated binaries into your game directory by running:
3521

3622
premake5 install "C:/Program Files (x86)/Rockstar Games/GTA San Andreas"
3723

38-
...replacing the path with your game directory.
39-
40-
If you are up to work with the project files you might want the files to be automatically installed everytime you build the solution, to accomplish that you should specify the *--idir=DESTDIR* option to premake5.
41-
For example:
24+
Or, you might want the files to be automatically installed everytime you build the solution:
4225

4326
premake5 vs2013 "--idir=C:/Program Files (x86)/Rockstar Games/GTA San Andreas"
4427

45-
Use *premake5 --help* for more command line options.
46-
47-
### License
48-
49-
The source code is licensed under the MIT License, giving you all the freedom you possibly want, see LICENSE for details.
50-
51-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
52-
Grand Theft Auto and all related trademarks are © Rockstar North 1997-2014.

0 commit comments

Comments
 (0)