Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is this project ready for public use? #11

Open
mikeseese opened this issue May 31, 2022 · 2 comments
Open

Is this project ready for public use? #11

mikeseese opened this issue May 31, 2022 · 2 comments

Comments

@mikeseese
Copy link
Contributor

mikeseese commented May 31, 2022

I'm really interested in using gamecure for my team, but due to the lack of documentation, I'm not sure if it's even ready for public use?

If it is ready for public use, I have a handful of questions since it's not all documented yet (here or on the blog post). I'd prefer not to create a new GitHub issue for each; is there a Discord/Slack I can join to ask these questions? Or perhaps it'd be better to open up the GitHub Discussions for the repo so we can discuss there rather than in Issues?

@mikeseese
Copy link
Contributor Author

mikeseese commented May 31, 2022

I've kind of answered my own question: it isn't really ready for public use unless you use the entire stack and development environment that GOALS does as is. Here are some notes for others trying to get started using this

  • You must set up a Google Cloud account and project. From there you can create a Google Cloud Storage Bucket. With all of that you can fill out the project, client_id, and container variables.
  • It assumes you have Jira and a url is set. This is easily mitigated by commenting out the two associated Jira references in the code
  • It assumes you already have a PlasticSCM repo that already contains the engine and game code/content (in the Engine and Game directories respectively). If you have a workflow where the engine and game are separate repositories, gamecure just isn't designed for that scenario currently. I'm not too sure, but I believe UGS has a similar workflow, so perhaps I'm just stubborn of having 1 engine for multiple projects
  • If I understand correctly, editor precompiled binaries get pushed to GCloud Storage using longtail upsync (in a separate tool/command line) which creates "indices" that are used for the diff downloading. More details on how it gets stored can be seen here: https://github.com/DanEngelbrecht/golongtail

Long story short, it's not ready for someone to just pick up and start using. It's missing quite a bit of documentation on how to set everything up and config variables to enable/disable different features

Probably a great tool, but still a fairly inflexible alpha meant for internal use

@mikeseese
Copy link
Contributor Author

mikeseese commented Jun 1, 2022

FWIW I've started making changes in a fork that allows some more flexibility for the points in my last comment with configuration variables to help drive the different functionalities. I'll make one or more PRs when I believe it's ready to be merged. I'll also try to write some basic documentation so users can understand how to get started using gamecure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant