FortuneStreetModding / csmm-qt

Custom Street Map Manager cross-platform port
GNU General Public License v3.0
4 stars 1 forks source link

csmm-qt - Custom Street Map Manager

Summary

csmm-qt is the cross-platform port of Custom Street Map Manager (CSMM). This tool allows modification of Boom Street, Fortune Street, and Itadaki Street Wii disc images.

Table of Contents

Using CSMM

For help using CSMM, please see the CSMM User Manual.

Building from Source

IMPORTANT: Make sure to use --recursive when cloning this repository, in order to initialize the submodules!

Build Requirements

Initial Steps

To start, clone this repository recursively Adding the --recursive flag is important as doing so will initialize the linked submodules:

git clone git@github.com:FortuneStreetModding/csmm-qt.git --recursive

Windows

Before you start, ensure OpenSSL is installed on your computer. When you deploy the Windows executable, you'll need to copy the libssl and libcrypto DLLs that come with OpenSSL into the binary's directory once the application has been built.

Windows uses the yaml-cpp and libbecquerel submodules in this repo, so there's no need to install these dependencies separately.

Just open CMakeLists.txt with Qt Creator and build the project with CMake.

MacOS

Mac users can most easily install csmm-qt's dependencies using Homebrew:

brew install libarchive yaml-cpp

libbecquerel does not need to be installed, as the submodule linked in this repo is used instead.

Once the dependencies are installed, you can proceed to open CMakeLists.txt with Qt Creator and build the project with CMake.

Linux

Ubuntu, Linux Mint, and Debian users can most easily install csmm-qt's dependencies with apt-get:

sudo apt-get install libyaml-cpp-dev libarchive-dev wget ninja-build libxkbcommon0 libxkbcommon-x11-0 python3-dev libxcb-cursor-dev

Users of other Linux distributions should install the above dependencies with thier favorite package manager. Just as it is with Mac OS, the Linux build process also uses the libbecquerel submodule linked in this repo, so it does not need to be installed separately.

Once the dependencies are installed, you can proceed to open CMakeLists.txt with Qt Creator and build the project with CMake.

Contributing

We welcome contributions! If you would like to contribute to the development of csmm-qt, please feel free to submit a PR with your changes, create an Issue to request a change, or join our Discord server to further discuss the future of Fortune Street modding!