1
0
mirror of https://github.com/pumpitupdev/pumptools.git synced 2024-11-27 16:10:55 +01:00

Main readme cleanup

- Obsolete link removal
- Formatting fixes
This commit is contained in:
icex2 2021-08-15 14:53:48 +02:00 committed by voidderef
parent 2bf7938f16
commit 7f852b99f6

View File

@ -1,5 +1,4 @@
# Pumptools: The ultimate toolset to run all Linux based PIU games on any* kernel and distribution
[![pipeline status](https://dev.s-ul.net/hackitup/pumptools/badges/master/pipeline.svg)](https://dev.s-ul.net/hackitup/pumptools/commits/master)
Version: 1.12
@ -9,9 +8,11 @@ This tool-set provides hook libraries that can be pre-loaded to run vanilla dump
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](#games-and-latest-versions-supported). 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
@ -20,11 +21,13 @@ dongle key tables and raw hdd areas (dummy files exist to allow full compilation
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](doc/README.md).
For release distribution packages, you can find a `doc.zip` file inside the `pumptools.zip` package that contains all
documentation also referenced from here:
* [pumptools api](doc/api/api.md)
* [pumptools development](doc/development/development.md)
* [pumptools's architecture](doc/development/architecture.md)
@ -32,7 +35,9 @@ documentation also referenced from here:
* [game hook libraries](doc/hook/hook.md)
## 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
@ -41,6 +46,7 @@ documentation also referenced from here:
* 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](doc/hook/hook.md). 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.
@ -60,16 +66,19 @@ available per game version)
* [NXA](doc/hook/nxahook.md): 110
Not available, yet:
* [Fiesta](doc/hook/fsthook.md): 120
* [FiestaEX](doc/hook/fexhook.md): 151
* [Fiesta 2](doc/hook/f2hook.md): 161
* [Prime](doc/hook/prihook.md): 122
### Prepare your operating system
Before you start installing and configuring anything of pumptools, read [this readme](doc/hook/os.md) on how to prepare
your operating system and environment.
### 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.
@ -77,6 +86,7 @@ For setting up the games, have a look at the dedicated readme files for
[each hook and game](#games-and-latest-versions-supported).
### 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
@ -84,7 +94,9 @@ document. Being aware of them will save you a lot of puzzling and time. Furtherm
section before as well to be aware of any known issues when you encounter them.
## Building
Make sure you have the [required tools](doc/development.md) installed. Once that's done, simply run
```shell script
make build
```
@ -96,6 +108,7 @@ distribution package called `pumptools.zip` can be found in the `build` subfolde
You can also build in a docker container. The container provides the necessary build environment and also ensures
[compatibility regarding glibc versions](doc/development/development.md#compatibility-issues-with-newer-glibc-versions).
```shell script
make build-docker
```
@ -103,17 +116,22 @@ make build-docker
The build output from the docker image is located in `build/docker`.
## Development
## API
Please refer to the [API documentation](doc/api/api.md).
## Architecture
A dedicate [architecture document](doc/architecture.md) 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](doc/development.md) 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](LICENSE) included with the source code.