much better looking readme for v2
This commit is contained in:
parent
c940480ac0
commit
2ff3a22698
49
README.md
49
README.md
|
|
@ -4,65 +4,46 @@
|
|||
  
|
||||
</div>
|
||||
|
||||
Some simple Shell scripts to setup ORC revivals semi-automatically on Linux.
|
||||
# 🍷 Some simple Shell scripts to setup ORC revivals automatically on Linux.
|
||||
|
||||
These scripts are not supported in any way, shape or form by the official devs of these revivals.
|
||||
|
||||
# What this does
|
||||
## ⚡ What this does
|
||||
This script will download dependencies, register URI and install the revival of choice. It can also install DXVK, use/make a custom Wineprefix (tadah and placeholder only) and uninstall the revival of choice.
|
||||
|
||||
# Dependencies
|
||||
## ⚠️ Requirements
|
||||
The needed packages are:
|
||||
- sudo (probably installed on most systems already, but if not please install it, because even with a supported distro the script won't install it for you)
|
||||
- sudo
|
||||
- The latest wine (obv, preferably wine-staging)
|
||||
- wget
|
||||
- unzip (for Itteblox only)
|
||||
The script can install WINE for you. However, only some distros are supported, so if it fails then you should install WINE and the other dependencies manually.
|
||||
|
||||
If you are running any form of Ubuntu (that includes Linux Mint and PopOS), Debian, Manjaro, Fedora or Gentoo the script will automatically install the dependencies for you.
|
||||
## 💻 How to use it
|
||||
|
||||
If you aren't, install them manually via your package manager.
|
||||
|
||||
# How to use it
|
||||
|
||||
0. If your distro is not listed above then install the dependencies.
|
||||
1. Download the latest release from the Releases page (or just clone this repo via git)
|
||||
2. Open a terminal and cd into where the script is downloaded.
|
||||
3. Run `chmod +x *.sh` (which will make all Shell files in that directory executable)
|
||||
4. Depending on which revival you want to install, run the following commands:
|
||||
- `./tadah-helper.sh` for Tadah
|
||||
- `./itteblox-helper.sh` for Itteblox
|
||||
- `./placeholder-helper.sh` for Placeholder
|
||||
4. Run `./wineorc.sh`
|
||||
5. Once installed, play a game and it should work!
|
||||
|
||||
If you want to install DXVK alongside the revival, run the script with the parameter "dxvk".
|
||||
See `./wineorc.sh --help` for all available options.
|
||||
|
||||
If you want to use/make a custom Wineprefix alongside the revival, run the script with the parameter "prefix". These two can also be used alongside each other.
|
||||
|
||||
If you want to uninstall a revival, run the script with the parameter "uninstall".
|
||||
|
||||
E.g, `./tadah-helper.sh dxvk/prefix/uninstall`
|
||||
|
||||
# Troubleshooting
|
||||
## ❗ Troubleshooting
|
||||
If the game crashes/doesn't launch, try to:
|
||||
|
||||
1. Downgrade to wine-staging/wine 7.6 (sortof-guide can be found at https://github.com/DarDarDoor/Wineorc/releases/tag/v1.6.10)
|
||||
2. Run the latest version of the installer again (make sure you're running it as non-root)
|
||||
3. Make sure the OS is set to `Windows 10` in `winecfg`
|
||||
4. Make sure all necessary optional wine dependencies are installed https://wiki.winehq.org/Building_Wine#Satisfying_Build_Dependencies
|
||||
1. Run the latest version of the installer again (make sure you're running it as non-root)
|
||||
2. Make sure all necessary optional wine dependencies are installed https://wiki.winehq.org/Building_Wine#Satisfying_Build_Dependencies
|
||||
|
||||
If those don't work, DM me on Discord: DarDarDar#3429.
|
||||
|
||||
# Known issues
|
||||
## 🗡️ Known issues
|
||||
|
||||
Tadah crashes if wine/wine-staging version is >7.6. (hopefully will be fixed in 7.8)
|
||||
Polygon 2012 seems to not work
|
||||
|
||||
ItteBlox needs to be installed to home directory, any other location won't work.
|
||||
|
||||
Placeholder Installer is a bit wonky (uninstaller seems to not work)
|
||||
|
||||
# Credits
|
||||
## Credits
|
||||
calones for helping me, and putting up with me being dumb
|
||||
|
||||
thexkey for helping me alot making the Placeholder helper
|
||||
|
||||
itteh, kinery and thexkey for making great revivals
|
||||
itteh, pizzaboxer, kinery and thexkey for making great revivals
|
||||
|
|
|
|||
Loading…
Reference in New Issue