Requires
- Base-level reqs
- clang Compiler
- git
- OS-specific reqs
- mac
- XCode
- Windows
- MSYS2
- mac
If you are reading this then you have probably already found the Splashkit-core Git repo, at least via the web client interface. To Follow these instructions you will need to fork and clone the Splashkit core SDK.
- Install brew.
- In Terminal run this command:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
. - Use brew to install basic tools.
- Write into terminal window:
brew install git svn mercurial
. - (optional) brew cask install atom.
- Install XCode.
- Install Command Line Tools by writing this into the terminal:
xcode-select --install
.
- Clone repository
- In Terminal, make a working directory (can also be on cloud) and then move into the directory using:
cd <YourProjFolder>
. - from in the directory run the git clone command
git clone <url>
- setup
- using
cd
go to the directory location:splashkit/coresdk/external
- Run setup.sh with
./setup.sh
- Go to the
coresdk/project
folder and open in XCode. - Build and Run from in XCode.
- If an issue, potentially consider temporarily disabling antivirus software.
- Install MSYS2 subsystem and follow fairly self-explanatory installer instructions – use defaults if unsure, DO NOT INSTALL TO DIRECTORY WITH SPACES!
- Install core Splashkit SDK
- Go into MSYS2 terminal emulator and install Git over MSYS2 subsystem by typing :
- Now clone and install Splashkit via install-scripts:
- Restart terminal, type
- Go into MSYS2 terminal emulator and install Git over MSYS2 subsystem by typing :
- Install VSCode.
- Install language tools (compilers / libs):
- For C#, install the DotNet core sdk.
- For C++, install GNU Compiler Collection (GCC) - g++ and clang++ in MSYS2.
- Run the following command in terminal:
- Do not run compiler from main MSYS2 MSYS terminal, instead run from MSYS2 MinGW32 or MinGW64 terminals.
- Run the following command in terminal:
- Install remaining tools to build Splashkit:
- Install cmake:
- install make:
- Install cmake:
- Build the test project:
- Go into the cloned directory of your Splashkit fork, open a MinGw-W64 MSYS2 shell and type:
``` cmake -G "Unix Makefiles" . ``` ``` make ``` - Note: if the above does not work, try using the actual unix make and cmake installations, rather than the MinGw-specific ones; but do not try a combination of both. Remove packages with ``` pacman -Rs <package> ``` and ``` pacman -S cmake make ```
- Go into the cloned directory of your Splashkit fork, open a MinGw-W64 MSYS2 shell and type:
- Run the test program by executing
cd ../../bin
./sktest ```
- Add features to code in
./coresdk
- Add test code into
coresdk/src/test
Now you should be good to go.