https://github.com/sam-k0/wotmodassistantcore
Cross-platform mod manager for World of Tanks
https://github.com/sam-k0/wotmodassistantcore
dotnet-core mod modmanager python world-of-tanks worldoftanks wotmod
Last synced: about 2 months ago
JSON representation
Cross-platform mod manager for World of Tanks
- Host: GitHub
- URL: https://github.com/sam-k0/wotmodassistantcore
- Owner: sam-k0
- License: lgpl-2.1
- Created: 2024-08-08T14:25:31.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T21:14:34.000Z (over 1 year ago)
- Last Synced: 2024-10-20T08:28:43.023Z (over 1 year ago)
- Topics: dotnet-core, mod, modmanager, python, world-of-tanks, worldoftanks, wotmod
- Language: C#
- Homepage: https://github.com/sam-k0/WoTModAssistantCore/wiki
- Size: 636 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
# WoT Mod Assistant
[](https://github.com/sam-k0/WoTModAssistantCore/actions/workflows/build_flatpak.yml)
A simple ~~cross-platform~~ mod manager for World of Tanks.
*Right now, compatibility with Windows should be possible but not guaranteed.*
### Compatibility
- Windows (10+)
- Linux
> [!IMPORTANT]
> As this tool is primarily developed on Linux, bugs and issues may arise on Windows.
> Please report any issues to the issue tracker.
MacOS/darwin support is not planned but not explicitly impossible.
### Features:
- Install, Uninstall mods
- Deactivate, Activate mods
- Import mods from previous game versions
- Move mods between different game versions
- View mod information
- Browse `wgmods.net` for mods
- Drag and drop mod installation for `.wotmod` files
- Version control for mods
- Example: If there's a dependency for two mods, and one of them is updated, the other will be automatically updated to the latest compatible version.
### Screenshots:
Planned features:
- [x] wgmods.net compatible mod browser integration:
- [x] Mod listing
- [x] Mod search by query
- [x] Local cache can be searched
- [x] .wotmod file download and install
- [x] .zip file download and install
- [ ] Modpack support
- [ ] Mod update checking
- [ ] `res_mods` directory support
- [ ] Localization / language support
- [x] Styling and theming
### Install
To install, the recommended way is to use the flatpak.
As I have not yet submitted the app to flathub, you will need to install it manually for now.
Download the latest release from the release page.
**Installing first time:**
`flatpak install --user --bundle WoTModAssistant.flatpak`
**Updating**
`flatpak update --user --reinstall --bundle WoTModAssistant.flatpak`
# Instructions below are for legacy version found in the releases tab.
As I am changing the whole project structure and code, there is no working release at the moment.
There will be a windows executable and linux flatpak or AppImage release.
## Installing
Following is an unfinished guide on how to install `ModManagerCore` and `ModManagerCoreGUI`.
> [!TIP]
> If you have trouble with automatic setup, please consult the `Manual Install`section of this readme.
### Linux
> [!TIP]
> You can also execute the `build_linux.sh` script after setting up a venv with pyside6 and pyinstaller installed.
> Also, builds can be found in the [release](https://github.com/sam-k0/WoTModAssistantCore/releases) tab.
1. Download or build the project.
2. Run `ModManagerGUI`.
3. It should prompt you to select your game directory.
4. Select the directory containing `WorldOfTanks.exe`
### Windows
> [!TIP]
> Please download the latest `Windows release` build from the [release](https://github.com/sam-k0/WoTModAssistantCore/releases) tab.
1. Download and unzip the latest release.
2. Run `ModManagerGUI.exe`.
3. On first run, it will prompt you to select the game directory, you can find it by checking the `WargamingGameCenter`->`World Of Tanks`->`Modify Installation`->`open game directory`.
4. Select the path to `WorldOfTanks.exe`.
## Manual Install & Setup
### Linux
1. Create a new directory `wotmodmanager`, and a directory called `Core` inside it.
2. Build or install the `ModManagerCore` to the newly created `wotmodmanager/Core` directory.
3. Install the CoreGUI in the parent folder, so that the `Core` directory one directory deeper as the `CoreGUI` executable.
4. Important step: Run the `ModManagerCore` executable, it will prompt you to enter your World of Tanks install directory path. This means the directory where `WorldOfTanks.exe` resides.
5. Now, run the `CoreGUI` and you should see it automatically listing mods.
### Windows
1. Download the `.zip` archive and extract.
2. Inside it, find the `_internal/Core` folder.
3. Run `ModManagerCore.exe` and set up your World Of Tanks install path (the directory where `WorldOfTanks.exe` resides.)
4. Run the `CoreGUI` from the main directory.
## Dependencies
- PySide6, PyInstaller, Python 3.11x `(ModManagerCoreGUI)`
- Newtonsoft.Json, .NET 8.0 `(ModManagerCore)`
Please check the project's subdirectories readme files for more information on how to build.
### Contributing
If you want to report bugs, request features or contribute to the project, please open an issue or a pull request.
Pull requests should be made to the `dev` branch.
Also, please make sure your code follows `cross-platform` standards and is tested on both Windows and Linux.
> [!IMPORTANT]
> Please make sure to provide a detailed description of issues.
> If you are submitting a pull request, please make sure to provide a detailed description of the changes.