Skip to content

Commit

Permalink
docs: add sections to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xaizone committed Nov 2, 2024
1 parent 68b6c53 commit f9207f2
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,22 @@ Personal [APB: Reloaded](https://store.steampowered.com/app/113400/APB_Reloaded/
> [!CAUTION]
> As of version v3.3, this config is not recommended for systems with under 32GB of system memory (RAM) due to disabled texture streaming, GC timer and raised GC memory ceiling. Use at your own risk. This config is provided "AS IS", without warranty of any kind, express or implied.
# Installation
## Method 1
## Features
- Disabled texture streaming, GC timer and raised GC memory ceiling for high FPS stutter free experience.
- Custom keybinds adding extra or missing functionality while fixing issues with the vanilla keybinds.
- Legal black login screen for faster game launching and changing characters.
- Competitive localization with mission stages and time limits with added verbosity and other QoL localization improvements from vanilla game.
- Graphical declutter while maintaining high quality player generated content.

## Installation
Two installation methods are listed below, I highly recommend using the standard [Method 1](#method-1) as that's the standard way people have been installing APB configs for years. However if you are an advanced user who would like to version their own config with ease, take a look at [Method 2](#method-2), more information is listed below.

### Method 1
0. Remove any pre-existing config (Run Launcher\APBLauncher.exe -> Repair).
1. Download the [latest release](https://github.com/xaizone/apb-reloaded/releases/latest) and copy everything to the APB root directory (e.g. C:\Program Files (x86)\Steam\steamapps\common\APB Reloaded).
2. Start your game with StartGame.bat or StartGame-NoSteam.bat.

## Method 2
### Method 2
> [!NOTE]
> This is for advanced users only. This allows you to version your APB config with ease, based on already established way of versioning dot files on Linux (https://www.atlassian.com/git/tutorials/dotfiles), allows you to run for example `git apb-cfg reset --hard` to remove all config experiments, or easily restore config after a game update.
0. Remove any pre-existing config (Run Launcher\APBLauncher.exe -> Repair).
Expand Down

0 comments on commit f9207f2

Please sign in to comment.