Python wrapper for SteamCMD
Project description
Py-SteamCMD-Wrapper
During the setup of game servers it can be infuriating to use SteamCMD due to some particularities within the SteamCMD Toolkit. This simple wrapper for python will handle everything from installation to downloading games.
Getting Started
These instructions will get you a copy of the project up and running on your machine for development and testing purposes
Prerequisites
When installing on linux, you'll need the 32-bit libraries specified on the valvesoftware website.
Ubuntu
sudo apt-get install lib32stdc++6
If you get an error for missing dependencies or broken packages, run the following
dpkg --add-architecture i386
apt-get update
apt-get install lib32gcc1
RHEL, Fedora, CentOS, etc.
yum install glibc.i686 libstdc++.i686
Arch Linux
Enable the multilib repository
pacman -S lib32-gcc-libs
Installing
Download the Py-SteamCMD-Wrapper library from github and place the pysteamcmdwrapper folder inside your project.
Pip package comming soon!
In order to install steam you have to do the following:
from pysteamcmdwrapper import SteamCMD
steam = SteamCMD("MyInstallationDir")
steam.install()
Usage
Curently there are 4 methods available in the wrapper. These are as follows:
- install
- login
- app_update
- workshop_update
You can use these methods to install steamcmd, login a user, download a game/gameserver or a workshop mod. If your game needs a valid subscription (AKA you've bought the game) the login function needs to be called. When left empty, it will prompt for login information.
A small code snippet to install an Arma III dedicated server with CBA_A3 installed
import os
from pysteamcmdwrapper import SteamCMD
SERVER_DIR = "armaserver"
WORKSHOP_DIR = os.path.join(os.getcwd(),"armamods","steamapps","workshop","content","107410")
MOD_DIR = os.path.join(os.getcwd(),SERVER_DIR)
s = SteamCMD("steamcmd")
try:
s.install()
except SteamCMDException:
print("Already installed, try to use the --force option to force installation")
s.login()
s.app_update(233780,os.path.join(os.getcwd(),SERVER_DIR),validate=True)
modname = "cba_a3"
id = "450814997"
s.workshop_update(107410,id,os.path.join(os.getcwd(),"armamods/"),validate=True)
try:
os.symlink(os.path.join(WORKSHOP_DIR,id),os.path.join(MOD_DIR,"@"+modname))
except FileExistsError:
print("Already linked")
keydir = os.path.join(MOD_DIR,"@"+modname,"keys")
if not os.path.isdir(keydir):
keydir = os.path.join(MOD_DIR,"@"+modname,"key")
for key in os.listdir(keydir):
print("Linking ",key)
try:
os.symlink(os.path.join(keydir,key),os.path.join(MOD_DIR,"keys",key))
except FileExistsError:
print("Already Linked")
This snippet can be used with another project of mine. This will be coming soon!
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to me.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Wouter Mellema - Initial work - wmellema
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
- f0rkz, whose original pysteamcmd project was abandoned, but still very usefull as a building block
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py-steamcmd-wrapper-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab0cc48260dd1a8b97d23b639a2fffe8f5d1387da956d055178177c749f55e2c |
|
MD5 | 705cc1e86d8d56f2ac1bc4cd600891cc |
|
BLAKE2b-256 | 1af7a4941cb0be6e293f86a7fc1f62df1c75822953b0201eb16e648034843cfc |
Hashes for py_steamcmd_wrapper-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2dc617523135298cf83e601edc5e80e04b1d8e4eb05ed75cf8902536bb11d27e |
|
MD5 | 6464bba93281b29656c6c158678b5807 |
|
BLAKE2b-256 | ce847e7ab4fbfd5e2b08ca6765e225d26a02f925318f593610f48a36bfdc73a3 |