gamesdk-and-dispatch icon indicating copy to clipboard operation
gamesdk-and-dispatch copied to clipboard

Proposal: put the C++ and C# wrappers on GitHub

Open sylveon opened this issue 4 years ago • 1 comments

Currently, the C++ and C# wrappers are distributed in source form in the Game SDK download zip. I believe it would be better to put them in this repo (or another) for the following reasons:

  • Users can contribute fixes. For example, fixes for #32, #46 and #89 could have been easily pull requested. But instead, we're stuck to patching the source code ourselves and keeping the patches up to date with new versions of the SDK.
  • Easier to script. Cloning a repo is much easier to script than copying the wrapper files outside of the zip. This helps with CI infrastructure scripts or package manager scripts (like vcpkg).
  • Easier to explore. When assisting a user with the Game SDK, you could use the repo to point them to a specific file or line, rather than using a screenshot of your IDE.
  • The wrappers can evolve outside the core SDK DLL. Wrappers aren't bound to SDK releases anymore, and can evolve with fixes and improvements faster than the core SDK's release cycle.

Note that I am not suggesting to use a permissive license (although that would be appreciated), the code could be uploaded but still require acceptance of the Developer TOS to use (since you need to accept it to access the DLL anyways). Contributors can sign a CLA to agree that their code contributions will be distributed with those terms as well.

sylveon avatar Jun 25 '20 19:06 sylveon

Putting the raw wrappers up is probably not what we want to do because they are auto-generated behind the scenes. The autogeneration is really useful in both our CI and in ensuring consistency in new methods and types.

I would like to open source the auto-generation that makes the wrappers, as that would be the "right" fix. I won't close this issue but that would be the path forward.

msciotti avatar Sep 16 '20 18:09 msciotti