Skip to content

Commit

Permalink
Formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
toebeann committed Mar 18, 2024
1 parent 15daa79 commit 046742f
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

# Tobey's BepInEx Pack for Chained Echoes

> [!IMPORTANT]\
> [!IMPORTANT]
>
> At present, Steam users _must_ switch to the `kickstarteralphabacker` beta branch to use this BepInEx pack!
This is a [BepInEx](https://github.com/BepInEx/BepInEx) pack for Chained Echoes, preconfigured and ready to use on Windows, macOS and Linux (including SteamOS)!
Expand Down Expand Up @@ -51,10 +52,12 @@ If you get stuck, refer to the [gib README](https://github.com/toebeann/gib#read

## Manual Installation

> [!WARNING]\
> [!WARNING]
>
> It is _strongly_ recommended that macOS users [install with gib](#macos-gib), as manual installation on macOS is _extremely_ tedious and error prone!
> [!TIP]\
> [!TIP]
>
> The game folder is the folder containing the game's executable (e.g. `Chained Echoes.exe`).
>
> Steam users can find the game folder by right-clicking the game in their Steam library and selecting `Manage` -> `Browse local files`.
Expand All @@ -68,8 +71,10 @@ To install manually, follow these instructions:
- Windows users: Run the game. If everything runs correctly, you will see the BepInEx console pop up on your desktop.
- Linux & macOS users: Follow the configuration instructions for your operating system below:

> [!IMPORTANT]\
> **With just this pack installed, you will not see any changes in-game!**\
> [!IMPORTANT]
>
> **With just this pack installed, you will not see any changes in-game!**
>
> Check the `LogOutput.log` file in the `BepInEx` folder to determine whether BepInEx has loaded.
### Configuration on Linux (SteamOS etc.)
Expand Down Expand Up @@ -105,12 +110,14 @@ At this moment you will not see any clear indication that BepInEx is working. It
## Installing mods
> [!NOTE]\
> [!NOTE]
>
> The paths in this section are relative to the game folder, i.e. `BepInEx/plugins` = `[game folder]/BepInEx/plugins`, where `[game folder]` is the path to the folder containing the game's executable (e.g. `Chained Echoes.exe`).
>
> Steam users can find the game folder by right-clicking the game in their Steam library and selecting `Manage` -> `Browse local files`.
> [!TIP]\
> [!TIP]
>
> "Extract the .zip" simply means take the contents of the .zip file and put them in the specified location.
>
> For example, if you are told to "extract the .zip" or "extract the contents of the archive" into `BepInEx/plugins`, then you can simply open the .zip archive by double-clicking on it, then just select everything inside and drag the contents into your `BepInEx/plugins` folder. Easy!
Expand Down

0 comments on commit 046742f

Please sign in to comment.