Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
249 lines (174 loc) · 6.97 KB

CONTRIBUTING.md

File metadata and controls

249 lines (174 loc) · 6.97 KB

SplashKit Development

macOS

Install prerequisites

  1. git and make are installed by default.

  2. Install XCode and Command Line Tools

    xcode-select --install

Build & test

  1. Create a fork of SplashKit.

  2. Clone the forked repository into your preferred location.

    git clone --recursive -j2 https://github.com/<username>/splashkit-core.git

  3. Build the test project:

    • In a terminal application, go into the cloned directory of your SplashKit fork, and type:

      cd projects/cmake
cmake .
make

  4. Run the test program by executing

    cd ../../bin
./sktest

  5. Add features to code in

    ./coresdk

  6. Add test code into coresdk/src/test. Now you should be good to go.

Linux

Install prerequisites

  1. Update your system

    sudo apt-get update
sudo apt-get upgrade -y

  2. Install the packages

    sudo apt-get install -y \
  git build-essential cmake g++ libpng-dev libcurl4-openssl-dev libsdl2-dev \
  libsdl2-mixer-dev libsdl2-gfx-dev libsdl2-image-dev libsdl2-net-dev libsdl2-ttf-dev \
  libmikmod-dev libbz2-dev libflac-dev libvorbis-dev libwebp-dev libfreetype6-dev

Build & test

  1. Create a fork of SplashKit.

  2. Clone the forked repository into your preferred location.

    git clone --recursive -j2 https://github.com/<username>/splashkit-core.git

  3. Build the test project:

    • In a terminal application, go into the cloned directory of your SplashKit fork, and type:

      cd projects/cmake
cmake .
make

  4. Run the test program by executing

    cd ../../bin
./sktest

  5. Add features to code in

    ./coresdk

  6. Add test code into coresdk/src/test. Now you should be good to go.

Windows

Install prerequisites

  1. Install MSYS2 subsystem and follow installer instructions - use defaults if unsure, DO NOT INSTALL TO DIRECTORY WITH SPACES!

  2. Install SplashKit SDK

    • Go into MSYS2 terminal emulator and install Git over MSYS2 subsystem by typing:

      pacman -S git --noconfirm --disable-download-timeout

    • Now clone and install SplashKit via install-scripts:

      bash <(curl -s https://raw.githubusercontent.com/splashkit/skm/master/install-scripts/skm-install.sh)

    • Restart terminal, type the following command in terminal to verify successfully installation.

      skm

  3. 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:

        pacman --disable-download-timeout -S mingw-w64-{x86_64,i686}-gcc mingw-w64-{i686,x86_64}-gdb

      • Do not run compiler from main MSYS2 MSYS terminal, instead run from MSYS2 MinGW32 or MinGW64 terminals.

  4. Install remaining tools to build Splashkit:

    • Install cmake

      pacman -S mingw-w64-x86_64-cmake

    • Install make

      pacman -S mingw-w64-x86_64-make

Build & test

  1. Create a fork of SplashKit.

  2. Clone the forked repository into your preferred location.

    git clone --recursive -j2 https://github.com/<username>/splashkit-core.git

  3. Build the test project:

    • Go into the cloned directory of your SplashKit fork, open a MinGw-W64 MSYS2 shell and type:

      cd projects/cmake
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 using the following command

      pacman -Rs <package>
pacman -S cmake make

  4. Run the test program by executing

    cd ../../bin
./sktest

  5. Add features to code in

    ./coresdk

  6. Add test code into coresdk/src/test. Now you should be good to go.

Folder Structure

Here is the folder structure tree for the SplashKit project:

splashkit-core
├── coresdk
│   ├── external
│   ├── lib
│   └── src
├── generated
├── out
├── projects
│   └── cmake
└── tools
    ├── scripts
    └── translator (submodule)

The folder structure is as follows:

  • coresdk/: This directory contains all the library files for SplashKit.
    • external/: This directory points to another repository that has libraries that are compiled externally.
    • lib/: This directory has all the libraries for each operating system.
    • src/: This directory has all the source code functionalities for SplashKit and the test/unit test files.
  • generated/: This directory contains the CMake's translation for the C files.
  • out/: This directory contains the output from the build process from tools/scripts.
  • projects/:
    • cmake/: This directory has the CMake configuration.
  • tools/:
    • scripts/: This directory has the deployment build script, Nuget Package deployment file, website deployment script.
    • translator/: This is a submodule pointing to the splashkit-translator repo. Note: Use git submodule update --init --recursive if you cannot access the folders in the submodule.

Resources Needed for the Project

CMake

CMake is an open-source, cross-platform family of tools designed to build, test and package software. It is used to control the software compilation process using simple platform and compiler independent configuration files, and generate native makefiles and workspaces that can be used in the compiler environment of your choice.[3] To learn more about CMake, you can refer to the official CMake documentation: https://cmake.org/documentation/

SplashKit Translator

The SplashKit Translator is a project that translates the SplashKit C++ source code into other languages. It uses HeaderDoc and a Ruby environment to generate the documentation.[1] You can find the SplashKit Translator repository on GitHub: https://github.com/splashkit/splashkit-translator

NuGet Package

The SplashKit NuGet package provides the SplashKit library for .NET projects. It allows you to easily add the SplashKit library to your C++ or C# projects.[2] You can find the SplashKit NuGet package on the NuGet Gallery: https://www.nuget.org/packages/SplashKit To use the SplashKit NuGet package, you can follow the instructions provided on the package page, such as adding the package reference to your project file or using the NuGet Package Manager Console.