NekoGakuen SteamworksAPI
A downloadable asset pack
================================
作者：貓咪學園 NekoGakuen
版本：1.1.4
聯絡推特：https://twitter.com/NekoGakuen
================================
─ 插件簡介 ─
在RPG Maker MV/MZ中也能使用來自Steam遊戲平台的API功能。
─ 素材內容 ─
Manual 線上使用手冊 x2
NekoGakuen_SteamworksAPI.js 插件 x1
NekoGakuen_SteamworksAPI_TransMod.js 翻譯補丁 x1
AutoBuildTool 快速部署Steamworks小工具 x1
Extra 小額付費/排行榜 - Alpha專案 x1
─ 使用說明 ─
1.需先完成一些前置步驟，請參閱放在Manual資料夾內的使用手冊連結。
2.在RPG Maker MV/MZ的「插件管理器」中匯入本插件，
並在本插件的「參數」區塊設定即可。
3.在事件頁中高級區塊選擇「插件命令...」，
並設定選擇要執行的插件命令及參數即可。
使用範例：https://nekogakuenweb.itch.io/warm-june
─ 支援平台 ─
- NWjs：
【√ 支援(Windows、macOS)】
- Electron：
【√ 支援(Windows、macOS)】
- Google Chrome：
【× 不支援】
- Mozilla Firefox：
【× 不支援】
- Microsoft Edge：
【× 不支援】
- Apple Safari：
【× 不支援】
- Android：
【× 不支援】
- iOS：
【× 不支援】
─ 著作聲明 ─
修改或翻譯本插件無需事前告知，如果插件有BUG可以回報。
本插件著作權為貓咪學園(NekoGakuen)所有。
並且保留對插件使用規則的修改與更動之權利。
--------------------
-來源標示：【△ 不需要，但有的話會很感謝。 (註1)】
-商業營利：【√ 允許】
-成人用途：【√ 允許】
※註1：但如有註明的話，可以註明「NekoGakuen」即可。
--------------------
================================
Author: NekoGakuen
Version: 1.1.4
Twitter: https://twitter.com/NekoGakuen
================================
─ Plugin Information ─
Let RPG Maker MV/MZ to use the API features from the Steam platform as well.
─ Material Content ─
Online Manual x2
NekoGakuen_SteamworksAPI.js x1
NekoGakuen_SteamworksAPI_TransMod.js x1
AutoBuildTool x1
Microtransactions/Leaderboards - Alpha Project x1
─ Use Description ─
1. There are a few pre-requisite steps to complete,
please refer to the manual link in the Manual folder.
2. Load the plugin in the "Plugin Manager" of RPG Maker MV/MZ.
3. Select the Advanced section of Event Commands "Plugin Command..." or "Script...",
and set the parameters of the "Plugin Command" or "Script" to be executed.
Usage Simple: https://nekogakuenweb.itch.io/warm-june
─ Supported Platforms ─
- NWjs:
[√ Yes(Windows、macOS)]
- Electron:
[√ Yes(Windows、macOS)]
- Google Chrome:
[× No]
- Mozilla Firefox:
[× No]
- Microsoft Edge:
[× No]
- Apple Safari:
[× No]
- Android:
[× No]
- iOS:
[× No]
─ Terms of Use ─
No prior notice is required to modify or translate this plugin, and if the plugin has bugs you can report them.
The copyright of this plugin is owned by NekoGakuen.
We also reserve the right to modify and change the rules of use of the plugin.
--------------------
- Credit:
[△ Not required, but appreciated if you have one. (#1)]
- Commercial:
[√ OK]
- Adults:
[√ OK]
#1：If you want to attach it, you can mark it with "NekoGakuen".
--------------------
Download
Click download now to get access to the following files:
Development log
- Update Ver 1.1.4Oct 21, 2023
- Update Ver 1.1.3Oct 12, 2023
- Update Ver 1.1.2Sep 13, 2023
- Update Ver 1.1.1Sep 08, 2023
- Update Ver 1.1.0Sep 05, 2023
- Update Ver 1.0.8Aug 25, 2023
- Update Ver 1.0.7Aug 25, 2023
- Update Ver 1.0.6Aug 23, 2023
Comments
Log in with itch.io to leave a comment.
Hello!! Thank you and nice work on your plugin, however I seem to have a problem.
I am trying to use plugin command 'Get Steam ID' which wants me to assign a variable to store the data.
However, when the plugin command executes, it fills it with [object Object]
When I try doing the script (SteamworksAPIManager.getSteamId) the same thing happens.
When I use console.log() it seems to report a lot of data, however I just want to grab the SteamID if possible.
Hi, this is the part where I wrote the wrong code and put the following in line 3066
SteamworksAPIManager.getSteamId = function (variablesId) {
if (!this.isSteamClientRun()) { return false; }
if (variablesId) {
$gameVariables.setValue(Number(variablesId),
this.greenworksCore.getSteamId());
}
return this.greenworksCore.getSteamId(); }
}
Change to
SteamworksAPIManager.getSteamId = function (variablesId) {
if (!this.isSteamClientRun()) { return false; }
var steamInfo = JSON.stringify(this.greenworksCore.getSteamId());
if (variablesId) {
$gameVariables.setValue(Number(variablesId), JSON.parse(steamInfo).steamId);
}
return JSON.parse(steamInfo).steamId; }
}; }
Ah wonderful, excellent work on this!
I am excited for Steamworks PLUS! o7
Hi! Thank you for making and sharing this plugin. I've been able to use it successfully for Steam achievements, but there's one small issue that I was wondering if you had any insight into. When the game is played in fullscreen (through F4 or a plugin), but it doesn't fill up the entire screen so there are black bars on the top and bottom (or left and right), when a Steam notification pops up on the lower right, it doesn't fade away completely and you can see it in the black bar area. This happens with achievements too. It'll remain there for the rest of the game unless I Alt-Tab or exit.
I'm not sure if this is something the plugin can solve, but if you have any suggestions for how I can get rid of this, I'd appreciate it. Thanks in advance!
Um.. I want to ask, is your game using NW.js or Electron.js?
If you still encounter issues with full-screen mode, you can also try my recently developed NekoGakuen SteamworksPlus plugin, which I wrote myself. It's a bit different from NekoGakuen SteamworksAPI in that it doesn't rely on Greenworks.js and doesn't require downloading the corresponding version of node, etc. However, I've been very busy lately and haven't had time to use machine translation to translate the plugin into English yet...🙇♀️
I'm using RPG Maker MZ and NW.js (updated to 0.49.1). Thanks for the suggestion - does your SteamworksPlus plugin also work with NW.js? Just wondering because the Itch page says NWjs: [× No]. :)
Ah... oops... I forgot to correct that. Thanks for your report. Actually, at first I thought this could only run on Electron.js, but later I found out that NW.js could also use the plugin I wrote. Anyway, this plugin can now be used on both NW.js and Electron.js.
(PS. I didn't expect that I forgot to switch back to my itch account to reply..)
Ok, thanks! I'll take a look at the SteamworksPlus plugin and use Google translate.
Hi RabbitTeaParty, thank you for your plugin. I got the Achievements set up alright. Do you also have instruction on how to send over the leaderboard data to steamworks?
I get nothing or an empty leaderboard ingame. But steamworks says no entry.
Leaderboards? I'll be adding a leaderboard feature sometime in the future...
So these can't be used yet? Than better take them out. I spent hours trying to get them to work.
Um... Actually, I've been busy recently developing NekoGakuen SteamworksPlus, which is a plugin I'm writing myself. It's a bit different from NekoGakuen SteamworksAPI in that it doesn't rely on Greenworks.js or require downloading corresponding versions of node, etc. It calls API functions directly from the native Steamworks SDK. Currently, I'm working hard on adding and researching leaderboard functionality. I hope you can give me some time to research the leaderboard feature. Also, at present, I've only created a Traditional Chinese version of the NekoGakuen SteamworksPlus plugin. Considering the large amount of text content in the plugin, I really need someone who can help translate it into English for the English version QAQ
Hello! I don't know if it's still active... but I'm facing problems with 'Bad Arguments' in my project, even after reading all the comments with errors similar to mine, I still haven't been able to find a solution :(
Hi ~ I'll give you this test nwjs first, can you press F8 to capture the debug screen and show me?
https://drive.google.com/file/d/1ypq3o2KBzZGxuvgEfICdnJYMOUDev5w-/view?usp=shari...
Should I replace my existing test nwjs? is in version 0.49.2
Uh... I was wondering if you put index.html in the same folder path as Game.exe?
Well, I hadn't put it in, should I?
It's the same index.html contained in the game project directory, right?
Yes..
I have solved the workshop part, I would like to submit my plugin to you, how can I contact you?
Hmm... I'll give you my e-mail, then.
Thank you very much.🙏
rabbitrabbitteaparty@gmail.com
Hi! I'm having trouble with the achievements. Every time I try to unlock one I get the following error:
There is nothing displayed in the logs either. Any tips on what could cause this? Thanks!
Hi ~ I'll give you this test nwjs first, can you press F8 to capture the debug screen and show me?
https://drive.google.com/file/d/1ypq3o2KBzZGxuvgEfICdnJYMOUDev5w-/view?usp=shari...
Thank you for your quick help. I replaced my version of nwjs with your version and now everything works correctly. Thanks a bunch!
Hi! I'm having trouble unlocking the achievements when I test the build on Steam. I already put the unlock achievement plugin command in the game, but when I test it on Steam, no achievement gets unlocked, and no pop-up of achievement unlocked. Please help. Thank you so much!
PS: I'm trying to test the achievements privately while the Store page is awaiting approval. Maybe this is also a factor?
That... You try to use nwjs version 0.83.0, and download the node file corresponding to version 0.83.0, then you try to upload it to dopot to download the test to see the game, if it still doesn't work, see if you want to share a screenshot of the error message to me, or go to the following Discord, and then DM my account.🙇♀️
https://discord.gg/qdR4qNQ
Hi there! Is there a way for a developer to watch the stat of users who use my game? I know how to check the leaderboard, but I don't know where to see the stat. Where can I see the user's stat on the Steamworks website? Thank you. :D
Thank you for your answer!
I know I can make stat here, but I'd like to see users' statistics. I looked into it and it looks like I should use the web API, is there any way for now?
Have a nice day :)
Hmm .... I've been a bit busy lately, I don't have much time for research .... I'm sorry.🙇♂️
That's fine, never mind. :D
You've already done cool enough! This is just my wish, I hope it will be possible one day in the future!
I have opened the steamworkshop, but I want the MODs to be downloaded to the specified directory in the game root directory.
I checked the documentation and this seems to require a script calling the steamwork api.https://partner.steamgames.com/doc/api/ISteamUGC
can you help me?
One more thing, "greenworks.js" was updated today, three years later.
Hmm... About the steam workshop part, honestly I haven't actually used it yet, so I'm really sorry...🙇♀️
https://github.com/greenheartgames/greenworks/blob/master/docs/workshop.md
I just noticed that greenworks provides relevant documentation.
I actually don't think this helps as it requires solving two problems at once.
1. When a user subscribes, the content needs to appear in the game subdirectory.
2. When the user unsubscribes from the item, it needs to be removed (still a subdirectory)
All in all, this is almost impossible for RPG makers.
I went through all the steps and set up the game on Steam and now when i try to launch it just repeatedly opens and closes the game, any help would be great.
edit- it is now opening a steamexample space game
Hmmm... How about you try disabling "Check BuyGame Boolean" in the Plugin Manager's Plugins parameter...😓
Okay so i re did everything and now when i use the steampipe build uploader and set the game as default it tells me that there is no game.exe but the nw.exe was renamed to game.exe so i do not know why it is telling me that there is no game.exe
That... Can you check on your computer to see if your game is in X:\Steam\steamapps\common\(your game name)\Game.exe?
yes my game.exe is in C:\Program Files (x86)\Steam\steamapps\common\(Game name)
That... Can you take a screenshot of some of the problems you're having, is the path correct, and do you have to press publish every time you change the background settings to update to it, or else.... You can try logging out of your computer's Steam client and then logging back in again to get the Steam client to update successfully....
Hello. whenever i try and unlock an achievement or check if any dlc is installed i get an unknown error TypeError: Bad arguments
Good evening~ That... I'll give you this test nwjs first, can you press F8 to capture the debug screen and show me? Thank you.🙏
Then, remember to modify steam_appid.txt ,and don't overwrite the package.json!
(by DeepL Translator🙇♀️)
https://drive.google.com/file/d/1ypq3o2KBzZGxuvgEfICdnJYMOUDev5w-/view
sorry for the late reply. No error shows in the console when this happens. It also happens when trying to unlock an achievement too
Well... Do you want to consider adding a new blank project, then copy all plugins and plugin.js files from the plugins folder to the blank project and send it to me...
Hello. below is a blank project. with all my plugins that i am using. as well as all of the files needed for steamworks. i have tried a few versions but they all have the same result or either dont load at all. there is an event which checks for DLC and achievement 2 tiles below the start which in testing reproduces the same error with nothing in the log
https://drive.google.com/file/d/1bAysOlkra5xSuZ3nJPKqMsi3DqmxiOCe/view?usp=shari...
Hi, so far it turns out that there was an error in the DLC part of the Steamworks plugin I wrote, and I've just fixed it and updated it to 1.1.3, so I'm really sorry for making you very troubled. 🙇♀️
https://rabbitteaparty.itch.io/nekogakuen-steamworksapi/devlog/619850/update-ver...
Hello, I thank you for making this plugin, the achievements system is working fine, but I was trying the Set Game Stats system (It is supposed to upload statistics to Steam) but it is not working correctly.
Gives the console message Stats value is not set.
Will there ever be a way to fix this?
I already tried it both in game test environment and exported.
Hi, thanks for your report, I have now updated the plugin for version 1.0.8 and fixed the issue where the stats function was not working properly.
(by DeepL Translator🙇♀️)
How are you. thanks for answering.
I don't know if I'm the one doing it wrong or what, but although now it doesn't give a console error (unlike before) I currently don't see that the scoring system is working.
Could you give me an explanation of how to use this functionality? I would really appreciate it!
For example, if I wanted to Upload a Points system to Steam, where I can see online on the Steam leaderboards the Username and the score they got (This can be a game variable)
And being able to download said information to put it into the game in some way.
Is what I'm thinking correct? Or does the system do something else?
From already thank you very much for your time!
Well... Stats and Leaderboards are different things, currently the plugin only has stats, maybe you can use Call Steam overlay and select Stats to see...
Ahhh I understand, sorry for the confusion of functions.
And will there be a way to implement Leaderboards in the plugin? At the moment I am trying to find some use for the stats
I apologize... I can't do leaderboards at the moment, and I have to work on weekdays, so I don't really want to spend time working on this kind of functionality, and I wrote the Steamworks plugin as a free plugin, so I really don't have much motivation to work on this kind of functionality!🙇♀️
Please help, I am too stupid to set it up. My game always gives out error: teamworksAPIManager is not defined
The Steam-Overlay works but Achievements are not getting unlocked.
Hi ~ I'll give you this test nwjs first, can you press F8 to capture the debug screen and show me?
https://drive.google.com/file/d/1ypq3o2KBzZGxuvgEfICdnJYMOUDev5w-/view?usp=shari...
Thank you so much for your quick response and your effort. I thought I had to take the newest version of the nwjs, with your package it runs without a problem and I sat days on it to figure it out XD
Only if I check the purchase of the game i get this error, see picture. But this is definetely my mistake again.
Anyhow I can unlock Achievements and check them now. Thank you!
Thank you for reporting... I did write the wrong code there, I'll update it right away.🙇♀️
Hello! The Check Unlocked Achievement might not be working. I made sure that I typed the achievement ID exactly as I have it on Steamworks, but it keeps returning false. I confirmed that the achievement is unlocked on Steam.
That aside, thank you so much for this plugin. It's amazing!
Hmm... Let me think about that for a second... so have you set up achievements in the Steamworks backend, as well as the public store page? If I remember correctly, if the store page is not public, you may not be able to unlock achievements .... Though I heard it from someone else....
(by DeepL Translator)
Yes, the Steamworks backend is set up and the game page is public. The achievements unlock properly, but checking for unlocked achievements seemed to only return False. The game itself is not released on Steam yet. Could that be it?
Maybe... Let's see if you want to come to my Discord.
I'll look at it for you in the morning...
https://discord.gg/qdR4qNQ
I would like to ask you if you clicked "Publish" on the instructions in the image below after adding the achievement in the Steamworks backend...
Yes I have.
Also, I joined your Discord, but I think it won't be easy because of the language barrier. Itchio has been automatically translating for us.
That... May I ask which version of nwjs you are currently using?
And I'm Mirai on Discord, and I was wondering what your Discord ID is @PotatoBlasters or @not me ...
Hi, does the Steam Overlay work with NWjs when it is updated higher than version 0.49.1? I'm using 0.63.1.
Of course it's fine, then when you download the node file, it should be compatible with version 0.63.1, as shown below...
If you need to work with Steam Deck, I recommend that you do not exceed version 0.67.1 of nwjs.
(by DeepL Translator)
Hello there. I'm using the plugin well. Do stats functions and related achievements work perfectly? Thank you for making a plugin.
Hello, although the statistics function has not been actually tested, but the achievement function is actually tested and can be used.
(by DeepL Translator)
Thank you for your anwser!