Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 2.73 KB

README.md

File metadata and controls

51 lines (42 loc) · 2.73 KB
Raw

PPGModCompiler

An open-sourced version of the People Playground Mod Compiler ("PPGMC" or "PPGModCompiler"). This works on macOS, Linux and Windows.

People Playground (PPG) and PPGMC was made by Studio Minus (https://studiominus.nl)!

WARNING

This hasn't been touched in a while, but I will definitely patch it up and renew all the code sometime soon!

How to Use

  • Download .NET 6.0, and install it.
  • Grab the source code for this repository as a .ZIP file & extract it, or use git (git clone https://github.com/StupidRepo/PPGModCompiler).
  • Run build.sh, if you're on a Linux or Mac machine.
  • After it's finished, find the executable by looking in the out folder, and run it.
  • The executable will make a config.json file - update the SteamPath entry inside config.json to your Steam install directory.
    • This can be one of the following:
      • Windows - C:/Program Files (x86)/Steam/
      • Linux - /home/[YOUR USERNAME]/.steam/steam/steamapps/
      • OS X - /Users/[YOUR USERNAME]/Library/Application Support/Steam/
    • It can also be any other path, but the ones above are a default. Examples of custom paths:
      • Windows - D:/SteamInstall/ or D:/SteamCMD
      • Linux - /home/[YOUR USERNAME]/Steam
      • OS X - /Volumes/SteamStuff/Steam
  • If you have input a valid path, it should run fine.
  • Open People Playground, and PPG should start compiling mods via the custom server. The first mod may fail to compile with the "asyncronous timeout" message. This is normal, and you can fix it by finding the mod, in the mod list, that failed, and pressing Recompile. This bug will be fixed soon.

Issues

If errors are occuring, either whilst building or running, make a new issue and I'll respond ASAP.

Contribution

Contribution is allowed and I recommend you do contribute. I'll accept PRs that:

  • Patch security issues/fix vulnerable code
  • Make compilation more efficient/reducing amount of code whilst being efficient
  • Fix issues in other areas (such as this README file)

I'll ignore PRs that are:

  • AI generated
  • Adding unwanted or generally uneeded code
  • Unoriginal and not creative

Sources

  • 100% Code from Visual Studio's Assembly Explorer thingy (on PPGModCompiler.dll from game)
    • Most of the variables were renamed to be more human-readable.

Credits

All credits go to Studio Minus for the code of both PPG and PPGMC. I'm just a person who decompiled it into a Visual Studio project for cross-platform building.