Squally - GitLite

KO | EN

gitlite — search

#javascript #python #react #golang #machine-learning #rust #docker #macos #nodejs #windows #awesome #mcp #openai #open-source

Squally

(★ 483)

2D Platformer Educational Game for Teaching Game Hacking - C++/cocos2d-x

파일 탐색기

최종 버전 다운로드 (.zip)

파일 수가 많아 일부만 표시됩니다. 전체 파일은 위 다운로드 버튼으로 확인해 주세요.

- c_cpp_properties.json
- cmake-kits.json
- launch.json
- settings.json
- tasks.json
- - GenerateStringFiles.py
.cocos-project.json
.gitattributes
.gitignore
.itch.toml
AGENTS.md
CMakeLists.txt
CMakeSettings.json
CopyResources.py

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/Squalr/Squally

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd Squally

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. CMake

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
CMake 빌드 설정을 생성하는 도구입니다.
C/C++ 컴파일러 Windows는 Visual Studio(Community 무료), macOS는 Xcode Command Line Tools, Linux는 gcc/g++ 패키지가 필요합니다.

cmake --build build/ --config RelWithDebInfo --target all --

이 명령어를 터미널에 그대로 입력해 실행하세요.

- Windows: Download the [installer](https://cmake.org/download/)

이 명령어를 터미널에 그대로 입력해 실행하세요.

- OSX: Use [Brew](https://brew.sh/) to install Cmake with the command `brew install cmake`

이 명령어를 터미널에 그대로 입력해 실행하세요.

- brew install cmake

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ build 폴더 안에 실행 파일이 생성됐는지 확인하고, 직접 실행해보세요 (예: ./build/앱이름).

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Squally
=========
2D Platformer Game for Teaching Game Hacking.

Language: C++

Engine: Cocos-2dx

Platforms: Windows, OSX, and Linux

[Steam Page](https://store.steampowered.com/app/770200/Squally/) / Discord: https://discord.gg/3maVXN5

![Squally Gameplay 1](https://i.imgur.com/M2KMSZ9.png) | ![Squally Gameplay 2](https://i.imgur.com/8jsCkX2.png)
------------ | -------------
![Squally Gameplay 3](https://i.imgur.com/1hvYk3K.png) | ![Squally Gameplay 4](https://i.imgur.com/bOSKa7p.png)
![Squally Gameplay 5](https://i.imgur.com/D9aIKSJ.png) | ![Squally Gameplay 6](https://i.imgur.com/iYUfJGq.png)
![Squally Gameplay 7](https://i.imgur.com/wGVSBFR.png) | ![Squally Gameplay 8](https://i.imgur.com/U7C2fXh.png)

Contributing
------------
To show support and help us finish development, [get the game on Steam](https://store.steampowered.com/app/770200/Squally/).

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

Issues |
------------ |
[Easy](https://github.com/Squalr/Squally/labels/good%20first%20issue) |
[Intermediate](https://github.com/Squalr/Squally/labels/good%20first%20issue%20%28intermediate%29) |

To edit maps, download [Tiled](https://www.mapeditor.org/). Maps are kept in Resources/Public/Platformer/Maps/*.tmx.

Compiling Squally
------------
To minimize cross-platform effort, we develop Squally using [VsCode](https://code.visualstudio.com/) 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 3.x (The CMake Tools extension does not include the cmake binaries) - cmake-3.31.6 is known to work properly
    - Windows: Download the [installer](https://cmake.org/download/)
    - OSX: Use [Brew](https://brew.sh/) to install Cmake with the command `brew install cmake`
    - Linux: Install via the instructions [here](https://cgold.readthedocs.io/en/latest/first-step/installation.html)
- [Ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages)
- Python 2.7.x or 3.x -- all scripts should be compatible with either version.

- Mac Software:
    - brew install cmake
    - brew install ninja
    - brew install freeglut

Squally is comprised of several subrepos, including:
- Cocos2d-x
- Spriter2d-x / SpriterPlusPlus
- Breakpad / AFNetworking
- SquallyResources* (Not public, copy this from Steam library)

**Linux Release**
These steps are only for compiling Squally specifically for RELEASING to Steam. Linux is agonizing torture, but the steps are as follows:

install podman (apt-get or whatever)
run `podman pull registry.gitlab.steamos.cloud/steamrt/sniper/sdk`
cd into `Squally`
modify `./proj.linux/LoadSteamRuntime.sh` to point to your Squally directory. Then pick which directory to mount it to in the Steam Runtime.
Run `./proj.linux/LoadSteamRuntime.sh`
cd into the mounted Squally directory
run `mkdir build`
run `cd build`
run `cmake ..`
run `cd ..`
run `cmake --build ./build`

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

To do a fresh build:
```
git clone git@github.com:Squalr/Squally.git
cd Squally
cmake --build build/ --config RelWithDebInfo --target all --
```

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

Getting the Resource Folder
------------
We could not include the `Squally/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 `Squally/Resources/Private` folder in the Steam copy of Squally will correspond to the master branch of this repository.

![Squally resource folder](https://i.imgur.com/5PaDZiG.png)

Additional learning resources
------------
Learning game hacking? Check out content from our partner [Guided Hacking](https://guidedhacking.com/)