mirror of
https://github.com/EricPlayZ/EGameTools.git
synced 2025-07-18 17:37:53 +08:00
Update README.md
This commit is contained in:
EricPlayZ
123
README.md
123
README.md
@ -1,72 +1,53 @@
|
||||
|
||||
# EGameTools - an ASI mod for Dying Light 2
|
||||
|
||||
## What is EGameTools?
|
||||
EGameTools (short for Eric's Game Tools) is an ASI mod menu developed in C++, using ImGui, which aims to help ease mod developers in the process of creating mods and which also aims to add new, additional features that the game does not provide by default, such as FreeCam, Weather and Time control, etc.
|
||||
|
||||
## What is an ASI?
|
||||
An ASI is basically just a DLL file with a different file extension. There's a certain ASI loader, in this case `winmm.dll`, which gets loaded by the game, and the ASI loader then scans the game folder for ASI files and injects them into the game process.
|
||||
|
||||
## Features
|
||||
Player:
|
||||
- God Mode
|
||||
- Freeze Player
|
||||
- Player Variables editing (with the ability to save and load to/from a `player_variables.scr`, restore to default values)
|
||||
|
||||
Camera:
|
||||
- FreeCam
|
||||
- Teleport Player to Camera
|
||||
- Third Person Mode
|
||||
- FOV slider
|
||||
- Disable PhotoMode Limits
|
||||
- Disable Safezone FOV Reduction
|
||||
|
||||
World:
|
||||
- Time slider
|
||||
- Weather control
|
||||
|
||||
**Check [EGameTools Trello](https://trello.com/b/oRaJQEOi/egametools-dying-light-2) to see what features or bugfixes I'm working on/planning to add!**
|
||||
|
||||
## Installation
|
||||
Download the latest archive from the [Releases](https://github.com/EricPlayZ/DL2GameOverhaul/releases) page and extract the files from inside the archive to the game's exe folder (`Dying Light 2\ph\work\bin\x64`).
|
||||
|
||||
## Uninstallation
|
||||
Delete `winmm.dll`, `EGameTools.asi` and `EGameTools.ini` from the game's exe folder (`Dying Light 2\ph\work\bin\x64`).
|
||||
|
||||
## How do I use it?
|
||||
When you launch the game, a console window will appear. When it does, **DON'T CLOSE IT!** Closing it will also close the game. This console is meant for debugging/troubleshooting purposes later down the road when the mod gets more complex.
|
||||
|
||||
By default, to toggle the mod menu, in-game press **F5** on your keyboard. The same key will open and close the menu. You can use your mouse to navigate the menu.
|
||||
A config file `EGameTools.ini` is stored in the same folder as the mod file. In here, there will be a value called `ToggleKey` where `VK_F5` is specified. This is the key for toggling the mod menu. To change it, visit [this link from Microsoft](https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes) which contains all virtual key codes. Simply write the name of the keycode you want to use and save the config file.
|
||||
|
||||
**YOU DON'T HAVE TO REOPEN THE GAME FOR CHANGES TO THE CONFIG FILE TO TAKE EFFECT!** Changes made to the config file are constantly refreshed in the mod, so you can edit the config file while the game is running. If you want to regenerate the config file, delete it and it will automatically create a new file.
|
||||
|
||||
For now, this config file is not very useful for most people as it saves some useless information such as last paths used in the Player Variables saving/loading dialogs, or toggles such as Disable PhotoMode Limits/Safezone FOV Reduction.
|
||||
|
||||
## Bugs/issues
|
||||
**Visit [EGameTools Trello](https://trello.com/b/oRaJQEOi/egametools-dying-light-2) to check for bugs/issues currently present in the mod, as well as features that I'm working on or planning to add!**
|
||||
|
||||
## Does this work with Multiplayer?
|
||||
It should mostly work, but there's some issues with God Mode for example not working properly, the code is made with singleplayer in mind and doesn't care about other players which can cause bugs. If you encounter bugs, please open a bug report, I will gladly take a look at it and see if I can find a workaround for multiplayer too.
|
||||
|
||||
## This isn't working anymore, what can I do?
|
||||
This mod is supposed to survive game updates, but sometimes it doesn't if there's a huge game update. If it's a big game update that broke the mod, I'm most likely already aware and already working on a fix. If not, please open a bug report!
|
||||
|
||||
## Credits
|
||||
[Ultimate ASI Loader](https://github.com/ThirteenAG/Ultimate-ASI-Loader)
|
||||
|
||||
[ImGui](https://github.com/ocornut/imgui)
|
||||
|
||||
[ImGuiFileDialog](https://github.com/aiekick/ImGuiFileDialog)
|
||||
|
||||
[minhook](https://github.com/TsudaKageyu/minhook)
|
||||
|
||||
[kiero](https://github.com/Rebzzel/kiero)
|
||||
|
||||
[OpenGameCamera](https://github.com/coltonon/OpenGameCamera)
|
||||
|
||||
And **@yeeeeeeee.** for helping me with certain issues I encountered <3
|
||||
Big thanks to **@coltychen** as well! <3
|
||||
|
||||
## License
|
||||
<p align="center">
|
||||
<img src="https://i.imgur.com/s6ZV1cz.png"/><br>
|
||||
<b>EGameTools (short for Eric's Game Tools) is a mod menu developed in C++ which aims to add additional features such as FreeCam, Third Person, Weather and Time control, etc. which the game does not provide by default and also to help ease mod developers in the process of creating mods.</b><br>
|
||||
<img src="https://i.imgur.com/M9VP0cv.png"/><br>
|
||||
<b>PLAYER</b><br>
|
||||
- God Mode<br>
|
||||
- Freeze Player<br>
|
||||
- Player Variables editing (with the ability to save and load to/from a `player_variables.scr`, restore to default values)<br><br>
|
||||
<b>CAMERA</b><br>
|
||||
- FreeCam<br>
|
||||
- Teleport Player to Camera<br>
|
||||
- Third Person<br>
|
||||
- FOV slider<br>
|
||||
- Disable PhotoMode Limits<br>
|
||||
- Disable Safezone FOV Reduction<br><br>
|
||||
<b>WORLD</b><br>
|
||||
- Time slider<br>
|
||||
- Weather control<br><br>
|
||||
<b>Check <a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">EGameTools' Trello</a> page to see what features or bug fixes I'm working on/planning to add!</b><br>
|
||||
<img src="https://i.imgur.com/kOyrZYC.png"/><br>
|
||||
<b>STEP 1: </b>Download the archive from the <a href="https://github.com/EricPlayZ/EGameTools/releases">Releases</a> section<br>
|
||||
<b>STEP 2: </b>Extract the files from inside the archive to the game's exe folder (<b>Dying Light 2\ph\work\bin\x64</b>).<br><br>
|
||||
To uninstall, delete <b>winmm.dll</b>, <b>EGameTools.asi</b> and <b>EGameTools.ini</b> from the game's exe folder (<b>Dying Light 2\ph\work\bin\x64</b>).<br>
|
||||
<img src="https://i.imgur.com/CRAQXjm.png"/><br>
|
||||
When you launch the game, a console window will appear. When it does, <b>DON'T CLOSE IT!</b> Closing it will also close the game.<br><br>
|
||||
To toggle the mod menu, in-game press <b>F5</b> on your keyboard. The same key will open and close the menu.<br>
|
||||
You can use your mouse to navigate the menu.<br><br>
|
||||
A config file <b>EGameTools.ini</b> is stored in the same folder as the mod file. There's a value called <b>ToggleKey</b> where <b>VK_F5</b> is specified.<br>
|
||||
This is the key for toggling the mod menu.<br>
|
||||
To change it through the config file, visit <a href="https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes">this link from Microsoft</a> which contains all virtual key codes. Simply write the name of the keycode you want to use and save the config file.<br><br>
|
||||
The menu includes hotkeys for each option which can be changed through the mod menu by clicking on the hotkey button and then pressing a key on your keyboard.<br><br>
|
||||
Changes to the mod menu or to the config file are always automatically saved or refreshed respectively.<br>
|
||||
You <b>DO NOT NEED</b> to restart the game for changes in the config to be applied!<br>
|
||||
If you want to regenerate the config file, delete it and it will automatically be regenerated.<br>
|
||||
<img src="https://i.imgur.com/m0X9akl.png"/><br>
|
||||
<b>Check <a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">EGameTools' Trello</a> page to see what features or bug fixes I'm working on/planning to add.</b><br><br>
|
||||
<b>DO NOT</b> use the discussions tab for bug reports.<br>
|
||||
If there is a bug you're encountering, open a bug report, otherwise please refrain from using the discussions tab unless you need help or want to request additional features!<br><br>
|
||||
Currently, this mod has been designed with <b>singleplayer</b> in mind. That means certain features might glitch out or completely stop working in <b>multiplayer</b>.<br>
|
||||
If that happens, please open a bug report!<br><br>
|
||||
This mod is supposed to survive game updates, but sometimes it doesn't if there's a huge game update. If it's a big game update that broke the mod, I'm most likely already aware and already working on a fix. If not, please open a bug report!<br>
|
||||
<img src="https://i.imgur.com/nbipzX1.png"/><br>
|
||||
<a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">Ultimate ASI Loader</a><br>
|
||||
<a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">ImGui</a><br>
|
||||
<a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">ImGuiFileDialog</a><br>
|
||||
<a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">minhook</a><br>
|
||||
<a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">kiero</a><br>
|
||||
<a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">OpenGameCamera</a><br>
|
||||
<a href="https://trello.com/b/oRaJQEOi/egametools-dying-light-2">ImGui-Custom-Hotkeys</a><br><br>
|
||||
And <b>@yeeeeeeee.</b> for helping me with certain issues I encountered <3<br>
|
||||
Big thanks to <b>@coltychen</b> as well! <3<br><br>
|
||||
This mod is licensed under the MIT License (included with the download and source code).
|
||||
</p>
|
||||
|
||||
Reference in New Issue
Block a user