Skip to content

Latest commit

 

History

History
97 lines (74 loc) · 4.27 KB

README.md

File metadata and controls

97 lines (74 loc) · 4.27 KB
Raw

Squally

2D Platformer Game for Teaching Game Hacking.

Language: C++

Engine: Cocos-2dx

Platforms: Windows, OSX, and Linux

Steam Page / Discord: https://discord.gg/3maVXN5

Squally Gameplay 1 Squally Gameplay 2
Squally Gameplay 3 Squally Gameplay 4
Squally Gameplay 5 Squally Gameplay 6

Contributing

To show support and help us finish development, get the game on Steam.

For those that wish to help with development, just hop over to the Issues tab and look for things to improve:

Issues
Easy
Intermediate

To edit maps, download Tiled. Maps are kept in Resources/Platformer/Maps/*.tmx.

Compiling Squally

To minimize cross-platform effort, we develop Squally using VsCode with the following extensions:

  • C/C++ for Visual Studio Code
  • CMake Tools
  • (Mac only) CodeLLDB is recommended, as this debugger works better than the default. Just be sure to go into Debug > Breakpoints > Disable C++: on throw

You will also need the following software to compile the project:

  • Cmake (The CMake Tools extension does not include the cmake binaries)
    • Windows: Download the installer
    • OSX: Use Brew to install Cmake with the command brew install cmake
    • Linux: Install via the instructions here
  • Ninja
  • Python 2.7.x or 3.x -- all scripts should be compatible with either version.

Squally is comprised of several subrepos, including:

  • Cocos2d-x
  • Spriter2d-x / SpriterPlusPlus
  • Breakpad / AFNetworking
  • Vcpkg
  • SquallyResources*

Additional dependencies are managed using vcpkg.

Important: We do not have the legal rights to distribute the art/sound in Squally. To get a copy of the Resources/Private folder, copy it from a purchased copy of the game. See the section below for details.

To do a fresh build and pull in dependencies:

git clone [email protected]:zcanann/Squally.git
cd Squally
git submodule update --init --recursive .
python dep.py init

From here, simply open the Squally/ folder in VsCode and compile using one of the following:

  • OSX: Clang 7.0.x
  • Windows: MSVC (VS2019 x86)
  • Linux: GCC

To update dependencies later:

git submodule update --init --recursive .
python dep.py update

Getting the Resource Folder

We could not include the Resources/Private folder in this repository, because a lot of the art in this game comes from asset stores. This means we have non-exclusive rights to the art, and cannot redistribute it for free. This means the Resources must be copied from a legally purchased copy of the game.

The Resources/Private folder in Squally will be synced up with the master branch in this repository.

Note: currently there is no master branch -- we temporarily removed it when making this repository public. It will be recreated before the next release.

To gain access to the Resources/Private folder being used in develop, do the following:

  • Open Steam
  • Right click on Squally and click Properties
  • Go to the BETAS tab
  • Opt into the 'resources' beta
  • Switch to the Local Files tab
  • Click 'browse Local files'
  • Copy the Private folder into Squally/Resources in the git repository you created.
  • Important: Revert back to NONE or alpha version of squally -- the 'resources' beta will not launch. Also, if Steam is not updating the files, try restarting Steam.

Squally resource beta Squally resource folder

For those that contribute significantly to the project, we can add you to the private repository. We're doing this sparringly because there are limted seats on Github.