Usage Guide
This guide provides an overview of how to use GameFlow Connect. From the initial setup to leveraging its core features, this document will walk you through the basics of managing game assets efficiently.
Overview
GameFlow Connect is designed to streamline collaboration and asset management for game developers and artists. It integrates with tools like Google Drive and GitHub to provide a unified experience.
1. Initial Setup
Here's a flowchart with Mermaid explaining how authentitcation process will work.
!!! note Before you begin, ensure that you have completed the installation process. If not, refer to the Getting Started guide.
Logging In
- Launch the Application: Start GameFlow Connect by running the executable file.
-
Authenticate:
- Google Drive: Log in with your Google account to enable file management.
- GitHub: Authenticate using your GitHub token for version control integration.
-
Dashboard Access: Upon logging in, you will be directed to the main dashboard.
Why Google Drive?
Our research with artists in Brazil revealed that many prefer using Google Drive due to its simplicity and ease of use.
Why GitHub?
Our current focus is on leveraging a robust platform like GitHub for seamless integration.
2. Managing Files with Google Drive
Connecting Your Account
- Go to the Google Drive tab in the sidebar.
- Click on Connect Account.
- Authenticate using your Google credentials.
- Once connected, your Google Drive files will be displayed.
Uploading Files
- Navigate to the File Management Panel.
- Select the Upload button.
- Choose a file from your local system.
- The file will be uploaded to your connected Google Drive account.
Downloading Files
- Browse your Google Drive files in the application.
- Select a file and click Download.
3. Using GitHub for Version Control
Here's a flowchart with Mermaid explaining how GitHub integration will work.
Connecting a Repository
- Go to the GitHub tab.
- Enter your repository URL or select from a list of connected repositories.
- Authenticate using your GitHub token.
Commit and Push Changes
- Make changes to your project files locally.
- Use the Commit Changes button to create a commit.
- Click Push to Repository to sync changes.
View File Versions
- Select a file in the File List.
- Click View Versions to see the version history.
4. Collaborating with Your Team
Real-Time Collaboration
- Enable Real-Time Sync in the settings.
- Changes made by your team will automatically sync.
Notifications
- Notifications about changes, uploads, and commits will appear in the dashboard.
5. Asset Visualization
Viewing Files
- Use the Preview Panel to view supported file types directly in the app.
- Images: PNG, JPG, etc.
- 3D Models: Integration planned for future versions.
Organizing Assets
- Use the File Tags feature to categorize your assets.
- Apply filters to find assets quickly.
Efficient Usage
- Shortcuts: Explore keyboard shortcuts in the settings for faster navigation.
- Help Section: Access troubleshooting steps directly from the app if you encounter issues.
- Feedback: Share feedback via the app to help improve future versions.
For any questions not covered here, refer to the FAQ or contact support.