Skip to content

Commit 6c5e919

Browse files
committed
Changed to normal API, Flat moved to experimental
1 parent bacdf6c commit 6c5e919

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,30 @@ Feel free to fork or contribute to this module.
55

66
Pre-builds for Windows and Linux here: https://github.com/Gramps/SteamworksPy/releases
77

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/
99

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**
1117

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
1519
Following files are required to be located in your project working directory:
1620
- steam_appid.txt - Stating your games app id or any other valid app id given the account owns a license
1721
- steam_api library (.dll, .so, .darwin) and the corresponding steam_api.lib
1822
- SteamworksPy library (.dll, .so, .darwin)
1923

2024
The library will only function if the Steam client is running and logged in. Otherwise you will encounter exceptions.
2125

22-
# Some Notes
26+
## Some Notes
2327
While I am still tinkering away with this, here are some things to note:
2428

2529
- You will need a Steamworks account, with a valid AppID, to use more advanced functions (set achievements, set stats, etc.)
2630
- 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/)
2732

28-
# Usage
33+
## Usage
2934
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)

library/SteamworksPy.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
//
77
// Include the Steamworks API header
88
#if defined( _WIN32 )
9-
#include "sdk\steam_api.h"
9+
#include "sdk\steam\steam_api.h"
1010
#define SW_PY extern "C" __declspec(dllexport)
1111
#elif defined( __APPLE__ )
12-
#include "sdk/steam_api.h"
12+
#include "sdk/steam/steam_api.h"
1313
#include "TargetConditionals.h"
1414
#define SW_PY extern "C" __attribute__ ((visibility("default")))
1515
#elif defined( __linux__ )
16-
#include "sdk/steam_api.h"
16+
#include "sdk/steam/steam_api.h"
1717
#define SW_PY extern "C" __attribute__ ((visibility("default")))
1818
#else
1919
#error "Unsupported platform"

0 commit comments

Comments
 (0)