Cool_Tools/pumptools
1
0
Fork 0
mirror of https://github.com/pumpitupdev/pumptools.git synced 2024-11-14 10:37:34 +01:00
Code Releases Activity
e75e05ea32
pumptools/README.md

5.4 KiB
Raw Blame History

Pumptools: The ultimate toolset to run all Linux based PIU games on any* kernel and distribution

Version: 1.12

Release history

This tool-set provides hook libraries that can be pre-loaded to run vanilla dumps of all Pump It Up games running on Linux. This also includes the only exclusive MK5 hardware based game Exceed and the MK3 Linux ports.

Public release note

Currently, the public release contains all source code required to run all games listed here. The following games however are currently not working due to missing dongle key tables and raw hdd areas (dummy files exist to allow full compilation of the project):

  • Fiesta
  • FiestaEX
  • Fiesta 2
  • Prime

The required assets to run these games will follow with future releases.

Documentation

Additional documentation on different topics related to pumptools are located in the doc subfolder here.

For release distribution packages, you can find a doc.zip file inside the pumptools.zip package that contains all documentation also referenced from here:

Hook libraries

Features

  • Run all supported games on recent hardware, Linux distributions and kernel versions
  • Environment sandboxing to increase compatibility and portability
  • API for hardware abstraction: Write your own drivers for IO devices
  • Full dongle emulation in software
  • Works with vanilla data, no hex edits
  • Various (bug)fixes and quality of live improvements for many games

Games and latest versions supported

All hooks share a major set of features provided by pumptools. Therefore, common topics are covered in the main hook readme. Start there when you are setting up a game with pumptools. Additionally, refer to each dedicated hook readme for further important and required information to successfully setup and run the games.

The following games are supported and tested with the latest versions available. Earlier version might also be support and work because of the nature the hooks are implemented.

Not available, yet:

Prepare your operating system

Before you start installing and configuring anything of pumptools, read this readme on how to prepare your operating system and environment. Please also note that not every Linux distribution and different versions were tested and verified working.

Get and prepare game data

You need vanilla, i.e. non-tempered and non-decrypted, game assets as well as non-tempered executable binaries which can be pulled from legit and clean physical disks or images of them.

For setting up the games, have a look at the dedicated readme files for each hook and game.

Setup hook libraries

READ THE WHOLE README OF THE HOOK BUILD YOU WANT TO USE FIRST BEFORE DOING ANYTHING!!!

The readme files go into great detail how to setup things with various potential relevant aspects spread across the document. Being aware of them will save you a lot of puzzling and time. Furthermore, read the FAQ/troubleshooting section before as well to be aware of any known issues when you encounter them.

Building

Make sure you have the required tools installed. Once that's done, simply run

make build

to build it on your current host from the root directory of this project.

The build output is located in the build subdirectory. The built binaries can be found in build/bin and a distribution package called pumptools.zip can be found in the build subfolder.

You can also build in a docker container. The container provides the necessary build environment and also ensures compatibility regarding glibc versions.

make build-docker

The build output from the docker image is located in build/docker.

Development

API

Please refer to the API documentation.

Architecture

A dedicate architecture document outlines the architecture of pumptools and points out the most important aspects you should know before you get started with development.

Pumptools development

Please refer to the development readme regarding what you have to know when you want to develop something for pumptools.

License

Source code license is the Unlicense; you are permitted to do with this as thou wilt. For details, please refer to the LICENSE file included with the source code.