diff --git a/README.md b/README.md new file mode 100644 index 0000000..f63bd5d --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Steam Play - FTEQW + +If you'd like a convenient way to use your system binary of FTEQW +in order to run games such as: + +- Quake +- Quake Mission Pack 1: Scourge of Armagon +- Quake Mission Pack 2: Dissolution of Eternity +- Quake II +- Quake II Mission Pack 1: The Reckoning +- Quake II Mission Pack 2: Ground Zero +- Quake III Arena +- Quake III: Team Arena +- HeXen II + +Then this is the right tool for you. + +# Dependencies +None, it expects your /bin/sh to handle arrays and things though. +And you want fteqw installed. Put it into $HOME/bin if that's in your $PATH +or something. You'll figure it out. + +# Installation +In order to install it, you just clone +the repository into your $HOME/.steam/steam/compatibilitytools.d/ directory. + +If the directory 'compatibilitytools.d' does not exist, make sure to create it. + +# License + +Copyright (c) 2021 Marco "eukara" Hladik + +Permission to use, copy, modify, and distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER +IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING +OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.