Skip to content

BepInEx mod to add Rich Discord Presence to the game Back to the Dawn.

License

Notifications You must be signed in to change notification settings

insomniac-eeper/BTTDRichDiscordPresence

Repository files navigation

Rich Discord Presence for Back to the Dawn

Caution

Back to the Dawn has switched from using mono to using il2cpp which means that this mod needs to use BepInEx 6..... The latest state of main has the necessary changes but readme changes are still TODO

Compatible version

  • Game : 1.3.82.10-RC
  • BepInEx: 5.4.22
  • Steam Build ID: 13665081

Description

A BepInEx plugin that adds rich discord presence support for the game Back to the Dawn. It uses the Discord GameSDK to communicate with Discord to set the rich presence. Internally it uses Monomod Runtime detours for game functions to keep track of the current game state, which is then interpreted to define the rich presence.

Features

Starting Game Presence

Game location

At the time of writing the images for locations are incomplete. Please refer to Asset Status for the latest state of available images.

Showing In-Game Location

Playing as

Character Image
Thomas Show playing as Thomas
Bob Show playing as bob
Reed Show playing as Reed

Save DateTime

In-game time is shown as Day X [HH:mm] where HH is 24 hours time and mm always shows two digits.

Showing in-game time

Battle Detection

Showing battle

Important Remarks

The integration makes use of a Discord application in order to refer to assets (as opposed to using links). This means that any asset must be uploaded to the appropriate Discord app and the associations references explicitly defined in the mod must be maintained.

Refer to the Asset Status section to see the current state of images.

Installation

This is a BepInEx plugin which can be installed by being placed in the /BepInEx/plugins directory after running the game with BepInEx installed. Please refer to Installing BepInEx for this.

Usage

Simply have Discord open while running the game. If you notice that your presence is changed to playing Back to the Dawn but no other information is visible it may be that Discord has auto-detected Back to the Dawn and is showing that instead of the rich presence. In order to solve this, disable detection of the Back to the Dawn game with a verified mark under Discord User Settings -> Activity Settings -> Registered Games.

Discord settings disable BTTD detection

Ensure the eye icon which is for detection is red or disabled

Windows

Things should work out of the box... If not please create an issue.

Linux

Your mileage may vary, it appears that the native Discord client works just fine (provided you define a RPC bridge, if needed). If you are using a solution that relies on arrpc you may find that the game process detectables trumps this mod (refer to detectables.json).

Getting things to build

  • Modify GameDir in Common.props to point to your game installation location

    • I should move this to csproj.user at some point...
  • Opening the solution in Visual Studio or Rider should automatically download the appropriate Discord GameSDK files.

    • This is done via the ./build/GetDiscordSDK.targets file. Currently it is a bit brittle but was fun to make :)
    • If you have trouble with this and/or are using an SDK that does not attempt to resolve the references automatically (thereby invoking the script) you an always download the SDK manually and put things into the appropropriate location.
      • Download v2.5.6 of the discord GameSDK.
      • Place the csharp library files into external/discordsdk/csharp
      • Place the contents of lib/x86_64 into external/discordsdk/native
  • Note that project build will try to copy plugin DLL to the BepInEx plugin directory but will not copy discord sdk native dll. This needs to be done manually until an extra build task is added.

  • This mod relies on generated runtime detour hooks which can be automatically generated with Bepinex.Monomod.HookGenPatcher. You may also further reduce the size of the generated file with the use of LighterPatcher.

Planned Features

  • Minigame detection
  • More detailed battle information
  • Gang association information

Asset Status

Identifier Type Status Image Notes
main_menu MapAsset ✔️ "Main Menu"
map_recreation_yard MapAsset ✔️ "Recreation Yard"
map_main_building MapAsset ✔️ "Main Building"
map_cell_block_a MapAsset ✔️ "Cell Block A"
map_cell_block_b MapAsset ✔️ "Cell Block B"
map_cell_a207 MapAsset ✔️ "Cell A207"
map_cell_a103 MapAsset ✔️ "Cell A103"
map_bathroom MapAsset ✔️ "Bathroom"
map_general_building MapAsset ✔️ "General Building"
map_barbershop MapAsset Not accessible yet
map_chapel MapAsset ✔️ "Chapel"
map_cafeteria MapAsset ✔️ "Cafeteria"
map_hiding_place MapAsset
map_infirmary MapAsset ✔️ "Infirmary"
map_segregation MapAsset ✔️ "Segregation"
map_laundry_room MapAsset
map_sewage_treatment_room MapAsset
map_kitchen MapAsset
map_guards_room MapAsset
map_roof_site MapAsset ✔️ "Roof Site"
map_wardens_office MapAsset
map_visit_room MapAsset
map_conjugal_visit_room MapAsset
map_court MapAsset
map_pipe_area MapAsset
map_central_garden MapAsset
map_sewage_pipe MapAsset
map_sewer MapAsset
map_mixing_room MapAsset
map_mailroom MapAsset
map_apartment_block MapAsset
map_college_dorm MapAsset
map_inmate_property_storeroom MapAsset
map_back_room_club MapAsset
map_rooftop_tool_shed MapAsset ✔️ "Rooftop Tool Shed"
map_fallen_angels MapAsset
map_private_room MapAsset
map_backstage_corridor MapAsset
map_dressing_room MapAsset
map_inner_hall MapAsset
map_chaplains_lounge MapAsset
map_kitchen_cellar MapAsset
map_cooking_room MapAsset
map_operating_room MapAsset
map_electrical_room MapAsset
map_house_in_the_suburbs MapAsset
map_road_in_the_suburbs MapAsset
map_visitation_corridor MapAsset
map_ground_behind_infirmary MapAsset
map_prison_cell_tower MapAsset
map_drain_depths MapAsset
map_tv_building MapAsset
map_hospital_ward MapAsset
map_city_cemetery MapAsset Not accessible yet
map_border_checkpoints MapAsset
map_fighters_room MapAsset
map_vip_box MapAsset
map_boxing_ring MapAsset ✔️ "Boxing Ring"
map_casino_alley MapAsset
character_thomas CharacterAsset ✔️ "Thomas"
character_reed CharacterAsset ✔️ "Reed"
character_bob CharacterAsset ✔️ "Bob"