You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,25 +5,30 @@ Feel free to fork or contribute to this module.
5
5
6
6
Pre-builds for Windows and Linux here: https://github.com/Gramps/SteamworksPy/releases
7
7
8
-
Full documentation is now available here: https://gramps.github.io/SteamworksPy/
8
+
Full documentation on getting started is now available here: https://gramps.github.io/SteamworksPy/
9
9
10
-
For a fuller (yet outdated) tutorial, with images, on SteamworksPy please read our post: http://coaguco.tumblr.com/post/128240756897/steamworks-for-python-tutorial-linux.
10
+
## What's New
11
+
Updates since February 1st, 2020
12
+
- Added: GetNumAchievements, GetAchievementName, GetAChievementDisplayAttribute by **aveao**
13
+
- Added: missing file for packaging by **tpchanho**
14
+
- Changed: organized Apps and Friends functions alphabetically to make editing easier
15
+
- Changed: ClearGameInfo to actual Steamworks function ClearRichPresence
16
+
- Fixed: argtypes for Workshop_SuspendDownloads by **tpchanho**
11
17
12
-
There is now an experimental branch for converting the project to match my [Godot Engine module](https://github.com/Gramps/GodotSteam) in functionality and fix some problems with the original. Once completed, it will move to the master branch.
13
-
14
-
# Requirements
18
+
## Requirements
15
19
Following files are required to be located in your project working directory:
16
20
- steam_appid.txt - Stating your games app id or any other valid app id given the account owns a license
17
21
- steam_api library (.dll, .so, .darwin) and the corresponding steam_api.lib
18
22
- SteamworksPy library (.dll, .so, .darwin)
19
23
20
24
The library will only function if the Steam client is running and logged in. Otherwise you will encounter exceptions.
21
25
22
-
# Some Notes
26
+
##Some Notes
23
27
While I am still tinkering away with this, here are some things to note:
24
28
25
29
- You will need a Steamworks account, with a valid AppID, to use more advanced functions (set achievements, set stats, etc.)
26
30
- Steam Overlay will only work if your game is using OpenGL or D3D! Overlay will only work if the game is actually launched from Steam itself. Possible if the SteamRestart command is fired; however, this is not implemented yet in SteamworksPy.
31
+
- Do not install Python from the Microsoft App Store. Make sure to [download and install it from Python's main site.](https://www.python.org/)
27
32
28
-
# Usage
33
+
##Usage
29
34
Please check the examples in the "examples" directory for a basic understanding of the module. For further reference you can go through the interface implementations itself or use the official Steamworks documentation (https://partner.steamgames.com/doc/api)
0 commit comments