Development repository for the third iteration of Peoplemon! This is still the first Peoplemon game, just our third try.
TODO: Build Peoplemon in CI and link to downloads here
For those working on Peoplemon, or anyone else wanting to try out some changes on their own, the below information provides some good starting points for getting to work.
- Editor Documentation
- Game Debugging
- Peoplemon bScript Reference
- C++ Source Documentation
- BLIB Engine Source Documentation
The Peoplemon editor may be used with the release build of Peoplemon, or may be used with the cloned source as well. Those wishing to make changes should follow the below instructions to clone the repository. Editor binaries may be downloaded from the releases page. Presently the binaries are only available for Windows. Once downloaded simply extract all the files and folders directly into the Peoplemon folder. More about the editor can be read here.
Anyone making changes to the core Peoplemon code (or the BLIB engine) must build from source. This requires CMake and a C++17 compliant compiler installed and configured to be used with CMake.
Those not added as collaborators should first fork Peoplemon. If forked, replace the below URL's with your own fork. Peoplemon's dependencies are bundled as submodules, so those must be initialized as well.
git clone git@github.com:benreid24/Peoplemon-3.git
cd Peoplemon-3
git submodule update --init --recursive
If on Windows you must also get the openal32.dll file from SFML:
cp lib/BLIB/lib/SFML/extlibs/bin/x64/openal32.dll ./
Once cloned Peoplemon and its dependencies may now be built using CMake. The following build commands and more are available in the VS Code build tasks file. Feel free to replace the generated build file type with your own system. Release builds may be used as well.
cmake -DCMAKE_BUILD_TYPE=Debug -G "Unix Makefiles" -S . -B ./build-debug
cd build-debug && make
If you have properly completed the setup and build steps you should now have runnable binary Peoplemon files to start the game with. When you make changes to any C++ code be sure to rerun the above build commands.