Repository files navigation

It is now maintained atInfectedBytes/gj-unity-api.

Game JoltGame API wrapper forUnity.

Check out thedocumentation.

Released underMIT.

Keeping/CHANGELOG.md up to date as new features are added make the release of new versions much simpler.

In addition, it gives a clear indication on what has been added/fixed/etc but not released yet.

The documentation is generated withDoxygen and can be used via the GUI or the CLI.

The configuration file can be found at/Documentation/Doxyfile. Unfortunately the paths are absolute and will depend on the developer machine.

To update the documentation, runmake doc_generate. To preview it, runmake doc_serve and visithttp://localhost:8000/. Finally, to publish the documentation,commit the changes tomaster andpush toorigin, then runmake doc_publish to copy theDocumentation/Output/html subdirectory to thegh-pages branch so the documentation will be available atloicteixeira.github.io/gj-unity-api/.

1. Update the version number followingSemantic Versioning.
   • VERSION in/Assets/Plugins/GameJolt/Scripts/API/Constants.cs.
   • PROJECT_NUMBER in/Documentation/Doxyfile.
2. UpdateCHANGELOG.md.
   • Convert theUnreleased section to the new version number, following the formatting of the previous versions.
   • Make sure to create the corresponding link at the bottom of the file
   • Make sure to update theunreleased link as well to it compare from the new version.
3. Commit the changes with the messageRelease vX.Y.Z.
4. Push the changes to the remote. See the2.2.0 release as an example.
5. Create the corresponding tag withgit tag vX.Y.Z.
6. Push the tag to the remote withgit push --tags

1. In theProject view, select thePlugins folder.
2. Right-click and chooseAssets > Export Package....
3. Uncheckinclude dependencies.
4. ClickExport.
5. Save asGameJoltUnityAPI_X.Y.Z.unitypackage in a folder which isn't tracked by git.

1. GitHub
   1. Go toCode > Releases.
   2. ClickDraft a new Release.
   3. Intag andversion, use the name of the tag created earlier. It should bevX.Y.Z.
   4. Copy the changes from the changelog in the body (formatting can stay the same)
   5. Attach the newly created package.
   6. ClickPublish release
2. GameJolt
   1. Go toDashboard > Your Games > Unity API > Manage.
   2. SelectPackages.
   3. FindUnity API v2 and clickManage.
   4. ClickNew Release.
   5. Set the version number.
   6. Attach the build as aDownloadable Build.
   7. SelectOther for theplatform.
   8. Publish.
   9. Create a news in theDevlog so the developers following the project are notified.
3. Unity Asset Store