Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
Conflicts:
	doc/config/modloader.ini.0
  • Loading branch information
thelink2012 committed Nov 24, 2014
2 parents 28b246a + dc48435 commit 9f5b6f8
Show file tree
Hide file tree
Showing 84 changed files with 1,994 additions and 1,145 deletions.
248 changes: 242 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,244 @@
bin
build
build2
msvc
nbproject
bin/
build/
build_temp/
msvc/
nbproject/
release/



#################
## C++
#################

# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app
!premake5.exe


#################
## GNU Make
#################
Makefile
release/gamedir
*.make

#################
## Visual Studio
#################

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.

# User-specific files
*.suo
*.user
*.userosscache
*.sln.docstates

# User-specific folders
*.sln.ide/

# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
build/
bld/
[Bb]in/
[Oo]bj/

# Roslyn cache directories
*.ide/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

#NUNIT
*.VisualState.xml
TestResult.xml

# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c

*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc

# Chutzpah Test files
_Chutzpah*

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opensdf
*.sdf
*.cachefile

# Visual Studio profiler
*.psess
*.vsp
*.vspx

# TFS 2012 Local Workspace
$tf/

# Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user

# JustCode is a .NET coding addin-in
.JustCode

# TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# NCrunch
_NCrunch_*
.*crunch*.local.xml

# MightyMoose
*.mm.*
AutoTest.Net/

# Web workbench (sass)
.sass-cache/

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish/

# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# TODO: Comment the next line if you want to checkin your web deploy settings
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj

# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/packages/*
# except build/, which is used as an MSBuild target.
!**/packages/build/
# If using the old MSBuild-Integrated Package Restore, uncomment this:
#!**/packages/repositories.config

# Windows Azure Build Output
csx/
*.build.csdef

# Windows Store app package directory
AppPackages/

# Others
sql/
*.Cache
ClientBin/
[Ss]tyle[Cc]op.*
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.pfx
*.publishsettings
node_modules/
bower_components/

# RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm

# SQL Server files
*.mdf
*.ldf

# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings

# Microsoft Fakes
FakesAssemblies/


48 changes: 0 additions & 48 deletions CMakeLists.txt

This file was deleted.

43 changes: 26 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,39 +18,48 @@ It certainlly is very helpful for developers, they don't have to be messing with
This is a open source project, so, feel free to learn and contribute!


### Compiling
### Compiling and Installing

If you are building from the source code, it is very simple to compile. You'll need the following:

+ [CMake](http://www.cmake.org/) 2.8 or greater
+ An C++11 compiler, tested with:
+ [Premake](http://industriousone.com/premake/download) 5 *(pre-built executable available in this repository root)*
+ An C++11 compiler, tested under:
- [Visual Studio](http://www.visualstudio.com/downloads) 2013 or greater
- [MinGW](http://mingw-w64.sourceforge.net/download.php) 4.8.2 or greater *(32 bits, SJLJ exception handling is prefered)*
- [MinGW](http://mingw-w64.sourceforge.net/download.php) 4.8.2 or greater


Then, in a terminal _(cmd.exe on Windows)_ go into the base source directory and run the commands:
Then, in a command-line shell go into the repository root directory and run the commands:

mkdir build
cd build
cmake ../

This will generate a project or make file for your target at the *build* folder.

To build and install you should do the following
+ __For Visual Studio__:

premake5 vs2013

then you can compile the generated project in the build directory

+ __For Visual Studio__: Open the generated solution file (*.sln*), setup it and build
+ __For MinGW__:

premake5 gmake
cd build
mingw32-make
mingw32-make install "DESTDIR=C:/Program Files (x86)/Rockstar Games/GTA San Andreas"
mingw32-make CC=gcc
cd ..


After such, you can install the generated binaries into your game directory by running

...replacing the path after `DESTDIR=` with your game directory.
premake5 install "C:/Program Files (x86)/Rockstar Games/GTA San Andreas"

...replacing the path with your game directory.

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.
For example:

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

Use *premake5 --help* for more command line options.

### License

The source code is licensed under GNU GPL v3, giving you the freedom to modify, create derivated works and more. See the LICENSE file for details.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Grand Theft Auto and all related trademarks are © Rockstar North 1997-2014.
Grand Theft Auto and all related trademarks are © Rockstar North 1997-2014.
1 change: 1 addition & 0 deletions deps/dummy.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// dummy cpp file to have 'doc/' as a project in premake (see premake5.lua for details)
Loading

0 comments on commit 9f5b6f8

Please sign in to comment.