chiaki-ng

(โ˜… 2,629)

Next-Generation of Chiaki (the open-source remote play client for PlayStation)

  • .appveyor.yml
  • .gitattributes
  • .gitignore
  • .gitmodules
  • CMakeLists.txt
  • CONTRIBUTOR_GUIDE.md
  • COPYING
  • meson.ini
  • mkdocs.yml
  • README.md
  • vcpkg.json

# Installation Guide

1. Get the code
git clone https://github.com/streetpea/chiaki-ng

Downloads the entire project code from GitHub to your computer.

cd chiaki-ng

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f scripts/Dockerfile.bionic -t chiaki-ng .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 chiaki-ng

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ ์ปดํŒŒ์ผ๋Ÿฌ Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

โœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd scripts/holepunch/holepunch-go

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.
// repository documentation