Add UE5 DiscordGameSample project #6607
Conversation
ooliver1
left a comment
ooliver1
left a comment
There was a problem hiding this comment.
The current UE4 cpp documentation is not very complete.
If that is so, you should make a discussion for that to be resolved, since people are still instructed to download the SDK with older examples.
| For a complete example of a reusable UE5 plugin that you can use for your UE5 project, | ||
| see this free, MIT licensed sample project: | ||
| [https://github.com/XistGG/DiscordGameSample]() |
There was a problem hiding this comment.
I disagree with the discord documentation relying on your repository to exist.
There was a problem hiding this comment.
third-party repositories should go in the Community Resources page
There was a problem hiding this comment.
Thank you both for your comments.
My intent in creating the example repository was to help the community. I spent a few days doing so and making it a complete, functional example that compiles and runs, complete with a lot of documentation and code comments.
If you don't want to link to an external repository, perhaps consider forking the repository into Discord's GitHub such that you are not reliant on a third party. The entire repository is the usage documentation. The high level overview is contained in the README.md in the root.
The primary purpose of this PR is to inform the Discord devs of this new, complete, working example of how to use the Discord GameSDK in a UE5 project.
If Discord wishes to keep the current poor quality of documentation relating to integration of GameSDK into UE, then that is fine by me. If on the other hand they wish to reference some or all of the example project I created, then they are welcome to do so in whatever way makes the most sense to them.
I am not a Discord dev, I am not being paid by Discord and I have no interest in spending time writing docs for Discord. I am a UE5 educator building UE5 projects to teach others how to do so. I will keep the README updated if/when changes are needed in my own repository.
Please feel free to use it or not, reference it or not, however you think is best. Do know that your current documentation for UE4 is not at all good and not at all functional, so to think you have something worthwhile at the moment would be a mistake.
There was a problem hiding this comment.
If Discord wishes to keep the current poor quality of documentation relating to integration of GameSDK into UE, then that is fine by me. If on the other hand they wish to reference some or all of the example project I created, then they are welcome to do so in whatever way makes the most sense to them
Your judging the quality of the documentation without improving it. On top of this, your project is far from perfect too, and I have many points to make about your project (sorry to say).
In my opinion, as someone who actively works with Unreal Engine on a daily basis, this plugin is far from well-made to be listed here. It's too hardcoded, you've put Discord's includes in the plugin's source folder rather than the ThirdParty folder (remember, you DO NOT own Discord's headers, you should have them in the ThirdParty folder), and you're distributing files in your project's repo that are useless.
Whilst i've never taken a look at the docs for the Discord GameSDK, i'd highly advise that if you're going to constantly state that it's "not at all good and not at all functional", you look at maybe changing that rather than giving a project that isn't to a good standard either.
There was a problem hiding this comment.
Thank you for the constructive criticism. It is true that the sample project isn't perfect and there are a number of ways to improve it.
It is also true that the current docs are at least an order of magnitude worse, and the sample is a massive improvement over it.
If your argument is that the current docs should be kept because the significantly-improved sample isn't perfect, then that does help to explain why the Discord SDK docs are so bad and seemingly unlikely to improve.
There is nothing hard coded in the sample project except the UCustomDiscordGameSubsystem, which if you had bothered to read the README you would know that it is intended to be completely discarded and replaced with your own custom subsystem that implements whatever behavior you actually want for your game. As the README very clearly states, the reusable and interesting parts are in the DiscordGame plugin, in which nothing is hardcoded and everything is fully documented.
|
I’ve read your README, I’ve not stated that my point is to keep the docs
the same way at all. I’m simply stating that if you’re that bothered,
change it yourself.
also, your point of “nothing is hard coded” is completely false, the
ClientID has to be baked into the constructor, which means blueprints can’t
change it. Why not allow blueprints to change it so people can just easily
use the sample project?
To word by point even better in hopes that you may understand, a sample
project here is NOT the right way to go about fixing the “bad
documentation”, either fix the documentation or don’t, a sample project
does not instruct people correctly.
…On Fri, 12 Jan 2024 at 15:03, Xist ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/game_sdk/SDK_Starter_Guide.md
<#6607 (comment)>
:
> @@ -232,6 +232,21 @@ Make sure you've got `core->RunCallbacks()` going every frame!
You're ready to go! Check out the rest of the documentation for more info on how to use the other pieces of the SDK. See an example of everything it can do in `examples/cpp/main.cpp` in the SDK zip file.
+## Code Primer - Unreal Engine 5 (Cpp) Plugin
+
+For a complete example of a reusable UE5 plugin that you can use for your UE5 project,
+see this free, MIT licensed sample project:
+
+[https://github.com/XistGG/DiscordGameSample]()
Thank you for the constructive criticism. It is true that the sample
project isn't perfect and there are a number of ways to improve it.
It is also true that the current docs are at least an order of magnitude
worse, and the sample is a massive improvement over it.
If your argument is that the current docs should be kept because the
significantly-improved sample isn't perfect, then that does help to explain
why the Discord SDK docs are so bad and seemingly unlikely to improve.
There is nothing hard coded in the sample project except the
UCustomDiscordGameSubsystem, which if you had bothered to read the README
you would know that it is intended to be completely discarded and replaced
with your own custom subsystem that implements whatever behavior you
actually want for your game. As the README very clearly states, the
reusable and interesting parts are in the DiscordGame plugin, in which
nothing is hardcoded and everything is fully documented.
—
Reply to this email directly, view it on GitHub
<#6607 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ALF2B6PBGIEKS3VPSHWOMJLYOFGFVAVCNFSM6AAAAABBQN2D2WVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTQMJYGQ3DMNBVGY>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
I haven't added any Blueprints support at all to the sample. It is purely C++; the intent is for the You do make a good point that the Also I do get that each of you who has responded has a genuine interest in improving the Discord documentation, and I appreciate that. Discord is lucky to have passionate people such as yourselves helping them out. Please understand that I am doing my best to help as well, but in my own way. I am providing these tools because (A) they are useful for me in my work; (B) they are useful for others who are already using them in their games; (C) I am a C++/UE educator whose goal is to help people develop their C++ skills. I have no interest in spending my time writing Discord docs. I am far too busy already. If anyone sees value in themselves improving the docs, I encourage them to do so. |
5 participants
The current UE4 cpp documentation is not very complete. I created a free, fully functional DiscordGameSample project including tons of documentation for how to use it.
This project makes it very simple for any dev to use Discord GameSDK.
This PR adds basic info and a link to the repository.