Difference between revisions of "Compiling for OS X"
(revamped and sectioned the entire tutorial. also all libs except sdl are on homebrew) |
(Standard meson notice) |
||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | This guide is for compiling TPT on OS X. | + | '''ATTENTION: This guide is outdated as of 2021. Please use this guide for building any recent version of the game: [[Building TPT with Meson]]''' |
| + | |||
| + | This guide is for compiling TPT on OS X. It should work on all OS X versions before Mavericks (OS X 10.9). It '''does not''' work on OS X 10.10 (Yosemite), 10.11 (El Capitan), or 10.12 (Sierra). | ||
If there are problems, try posting your errors on the development help section of the forums, or coming onto [http://webchat.freenode.net/?channels=#powder irc]. | If there are problems, try posting your errors on the development help section of the forums, or coming onto [http://webchat.freenode.net/?channels=#powder irc]. | ||
| + | |||
| + | == Installing Xcode == | ||
| + | |||
| + | This step is optional, if you don't want to install Xcode (very large, 3 GB), then instead follow the section "Installing the command line tools". You'll probably want another IDE to edit the code with if you don't use Xcode. | ||
| + | |||
| + | Download [http://itunes.apple.com/us/app/xcode/id497799835?ls=1&mt=12 Xcode] from the App Store. If you are on OS X 10.7 you will have to register a developer account and download 4.6.3 [https://developer.apple.com/downloads/index.action here]. | ||
| + | |||
| + | Install and open Xcode. Go to Xcode -> Preferences and click on Downloads. Install "Command Line Tools" | ||
== Installing the command-line tools == | == Installing the command-line tools == | ||
| − | If you' | + | If you don't want to install Xcode due to the size or other reasons, follow this section instead. If you already have Xcode and the command line tools, skip ahead. |
| − | + | There are some smaller downloads for just the command line tools in the [https://developer.apple.com/downloads/index.action?name=Xcode Apple developer website]. You'll need an [https://developer.apple.com/register/ Apple ID with developer access] to get to it, though! | |
| − | + | [http://i.imgur.com/NzuvEKT.png (Here's the kind of thing you have to download. Make sure the version matches your OSX version!)] | |
== Option #1: Homebrew == | == Option #1: Homebrew == | ||
| − | Install [http://brew.sh Homebrew] - this will give you easy access to each of the libraries below. You can then install | + | Install [http://brew.sh Homebrew] - this will give you easy access to each of the libraries below. You can then install all the necessary tools and libraries with it: |
| − | <code bash>brew install fftw lua | + | <code bash>brew install fftw scons sdl2 lua@5.1</code> |
| − | |||
== Option #2: Manual library installation == | == Option #2: Manual library installation == | ||
| Line 24: | Line 33: | ||
(you can use tab to complete a folder name so you don't have to type it all out). Next type <code bash>sudo python setup.py install</code>. The terminal will ask you for your password. Note that you can not see your password while you are typing it in. You now have scons installed. Keep the terminal open for later. | (you can use tab to complete a folder name so you don't have to type it all out). Next type <code bash>sudo python setup.py install</code>. The terminal will ask you for your password. Note that you can not see your password while you are typing it in. You now have scons installed. Keep the terminal open for later. | ||
| − | === Getting | + | === Getting FFTW === |
| − | Download the [http://www. | + | Download the [http://www.fftw.org/fftw-3.3.4.tar.gz fftw3 source]. Double click to extract it, then go back to the terminal and type <code bash>cd ../fftw-3.3.4/</code>. Once in the fftw folder, type <code bash>./configure && make </code>. Some different options may be needed to make it compile (I used a lot) but maybe this works. |
| − | + | == Getting Lua == | |
| − | Download the [http://www. | + | Download the [http://www.lua.org/ftp/lua-5.1.5.tar.gz lua source]. Double click to extract it, then go back to the terminal and type <code bash>cd ../lua-5.1.5/</code>. Once in the lua folder, type <code bash>make macosx</code> and then <code bash>sudo make install</code>. The lua library is now installed. |
== Getting SDL == | == Getting SDL == | ||
| − | |||
| − | |||
Download the [https://www.libsdl.org/release/SDL-1.2.15.dmg SDL framework]. Open the freshly downloaded DMG file and drag SDL.Framework to the folder <code>/Library/Frameworks/</code> | Download the [https://www.libsdl.org/release/SDL-1.2.15.dmg SDL framework]. Open the freshly downloaded DMG file and drag SDL.Framework to the folder <code>/Library/Frameworks/</code> | ||
| Line 43: | Line 50: | ||
First, use <code bash>cd ~/Documents/TPT</code> to move to the project directory, then | First, use <code bash>cd ~/Documents/TPT</code> to move to the project directory, then | ||
| − | <code bash>git clone https://github.com/ | + | <code bash>git clone https://github.com/The-Powder-Toy/The-Powder-Toy.git .</code> to clone all the history. The dot at the end means that we won't make a new subdirectory inside the TPT project directory. |
At the end of this we have a fully functional environment to build, as well as a local copy of the entire project. Great job! :D | At the end of this we have a fully functional environment to build, as well as a local copy of the entire project. Great job! :D | ||
| Line 50: | Line 57: | ||
This is the part you've been waiting for - type <code bash>scons</code> into the terminal and press enter. The script will check if your environment is alright (it is) and then it'll start compiling each of the source code files. | This is the part you've been waiting for - type <code bash>scons</code> into the terminal and press enter. The script will check if your environment is alright (it is) and then it'll start compiling each of the source code files. | ||
| + | |||
| + | For a list of all the options you can give to scons, see [[Scons_command_line_flags]]. | ||
| + | |||
| + | Additionally, compiler flags can be added with the CFLAGS and CXXFLAGS environment variables. For example, the <code bash>march</code> (microarchitecture) can be set specific to the host machine for minor performance improvements: <code bash>CFLAGS="-march=native" CXXFLAGS="-march=native" scons</code>. | ||
== Aftermath == | == Aftermath == | ||
| − | If it compiled without errors, you will find a file called powder-x in the build folder. Double click it and run it. | + | If it compiled without errors, you will find a file called <code>powder-x</code> or <code>powder64-x</code> in the build folder. Double click it and run it. |
Congrats, you have compiled the source code and have made a OS X application. | Congrats, you have compiled the source code and have made a OS X application. | ||
| − | This was written by Candunc, rewritten by jmeyer2k, and fixed again by jacob1, and cleaned up by boxmein | + | This was written by Candunc, rewritten by jmeyer2k, and fixed again by jacob1, and cleaned up by boxmein. Thanks to the editors on the Mac OS X compile page, and thanks to people at Mac Rumors and Ximon to help me find out various errors. |
I hope this helps future users become Mac Compilers and push TPT to Mac users! | I hope this helps future users become Mac Compilers and push TPT to Mac users! | ||
[[Category:Compiling]] | [[Category:Compiling]] | ||
Latest revision as of 05:48, 25 June 2021
ATTENTION: This guide is outdated as of 2021. Please use this guide for building any recent version of the game: Building TPT with Meson
This guide is for compiling TPT on OS X. It should work on all OS X versions before Mavericks (OS X 10.9). It does not work on OS X 10.10 (Yosemite), 10.11 (El Capitan), or 10.12 (Sierra).
If there are problems, try posting your errors on the development help section of the forums, or coming onto irc.
Contents
Installing Xcode
This step is optional, if you don't want to install Xcode (very large, 3 GB), then instead follow the section "Installing the command line tools". You'll probably want another IDE to edit the code with if you don't use Xcode.
Download Xcode from the App Store. If you are on OS X 10.7 you will have to register a developer account and download 4.6.3 here.
Install and open Xcode. Go to Xcode -> Preferences and click on Downloads. Install "Command Line Tools"
Installing the command-line tools
If you don't want to install Xcode due to the size or other reasons, follow this section instead. If you already have Xcode and the command line tools, skip ahead.
There are some smaller downloads for just the command line tools in the Apple developer website. You'll need an Apple ID with developer access to get to it, though!
(Here's the kind of thing you have to download. Make sure the version matches your OSX version!)
Option #1: Homebrew
Install Homebrew - this will give you easy access to each of the libraries below. You can then install all the necessary tools and libraries with it:
brew install fftw scons sdl2 lua@5.1
Option #2: Manual library installation
Compiling scons
Download scons and unzip it. Go into the terminal, and type in cd ~/Downloads/scons-2.3.0/
(you can use tab to complete a folder name so you don't have to type it all out). Next type sudo python setup.py install. The terminal will ask you for your password. Note that you can not see your password while you are typing it in. You now have scons installed. Keep the terminal open for later.
Getting FFTW
Download the fftw3 source. Double click to extract it, then go back to the terminal and type cd ../fftw-3.3.4/. Once in the fftw folder, type ./configure && make . Some different options may be needed to make it compile (I used a lot) but maybe this works.
Getting Lua
Download the lua source. Double click to extract it, then go back to the terminal and type cd ../lua-5.1.5/. Once in the lua folder, type make macosx and then sudo make install. The lua library is now installed.
Getting SDL
Download the SDL framework. Open the freshly downloaded DMG file and drag SDL.Framework to the folder /Library/Frameworks/
Getting TPT source code
Make a new folder in your Documents called "TPT" - this will become your project directory for all the TPT source code. We'll now download the entire commit history to that folder - this will let you add your own commits, creating your unique code project.
First, use cd ~/Documents/TPT to move to the project directory, then
git clone https://github.com/The-Powder-Toy/The-Powder-Toy.git . to clone all the history. The dot at the end means that we won't make a new subdirectory inside the TPT project directory.
At the end of this we have a fully functional environment to build, as well as a local copy of the entire project. Great job! :D
Building
This is the part you've been waiting for - type scons into the terminal and press enter. The script will check if your environment is alright (it is) and then it'll start compiling each of the source code files.
For a list of all the options you can give to scons, see Scons_command_line_flags.
Additionally, compiler flags can be added with the CFLAGS and CXXFLAGS environment variables. For example, the march (microarchitecture) can be set specific to the host machine for minor performance improvements: CFLAGS="-march=native" CXXFLAGS="-march=native" scons.
Aftermath
If it compiled without errors, you will find a file called powder-x or powder64-x in the build folder. Double click it and run it.
Congrats, you have compiled the source code and have made a OS X application.
This was written by Candunc, rewritten by jmeyer2k, and fixed again by jacob1, and cleaned up by boxmein. Thanks to the editors on the Mac OS X compile page, and thanks to people at Mac Rumors and Ximon to help me find out various errors.
I hope this helps future users become Mac Compilers and push TPT to Mac users!
