Repository navigation
Releases
Start.GG Graphic Generator - netlify generator [0.4.3] August Update
# StartGG Graphic Generator
The StartGG Graphic Generator is an application designed to simplify the creation and deployment of HTML graphics for Start.GG tournaments and leagues.
New Features
- Additional saved settings: allows for all settings to be saved to the standard profile
- League Server Mode: use server mode to generate and push a new graphic to Netlify every 30 seconds for a live leaderboard view
League Server Mode Notes:
- this only works Leagues
- The application will lock itself while Server Mode is running, to unlock it and stop server mode, close and re-open the app
- the app will run slow when server mode is open, it takes minimal performance from the rest of your PC
- if you minimize, resize, or move the app window while server mode is running, it may take a few seconds to update
StartGG Graphic Generator - User Guide
Overview
The StartGG Graphic Generator is an application designed to fetch event data and standings from the Start.GG API, generate HTML graphics based on this data, and optionally deploy these graphics to a Netlify site.
Features
- Fetch Event Data and Standings
- Generate HTML Graphics
- Deploy to Netlify
- Server Mode: Periodically generate and deploy graphics automatically.
- Updater: Updates to latest version on GitHub
Using the Application
Initial Setup
-
Install Dependencies:
Ensure you have the required dependencies installed, such as .NET SDK and Netlify CLI. -
Configure Settings:
Open the application and configure the following settings:- Start.GG API Key: Enter your Start.GG API key.
- Tournament/League URL: Enter the URL of the tournament or league.
- Netlify Site ID: Enter your Netlify Site ID (if you plan to deploy to Netlify).
- Netlify Access Token: Enter your Netlify Access Token (if you plan to deploy to Netlify).
- Select Color: Choose a color for the HTML graphics.
- Drag and Drop Image: Optionally, drag and drop an image to include in the HTML graphics.
-
Save Settings:
Click the "Save Settings" button to save your current configuration for future use.
Fetching Event Data
-
Fetch Events:
- Click the "Fetch Events" button to retrieve events from the provided tournament/league URL.
- The application will display buttons for each fetched event.
-
View Event Details:
- Click on any event button to fetch and display player standings for that event.
Generating HTML Graphics
-
Generate HTML:
- After fetching the player standings, the application will generate HTML graphics based on the data.
- The generated HTML will include player names, placements, and optionally the dropped image.
-
View HTML:
- The generated HTML file will be saved locally and opened in your default web browser for viewing.
Deploying to Netlify
- Deploy to Netlify:
- Ensure that the "Push to Server" checkbox is checked.
- The generated HTML file will be deployed to your specified Netlify site.
- If you have configured your Netlify settings correctly, the deployment will happen automatically.
Server Mode
-
Enable Server Mode:
- Check the "Server Mode" checkbox to prime the server mode.
- Server mode does not start immediately upon checking the box; it needs to be triggered by fetching standings.
-
Activate Server Mode:
- Click the "Fetch Standings" button to start server mode.
- When server mode is active, the application will generate and push new graphics every 30 seconds.
- A transparent grey overlay will appear over the entire application, indicating that server mode is running.
-
Exit Server Mode:
- To exit server mode and make settings editable again, you will need to restart the application.
- Server mode will be disabled until it is triggered again.
Drag-and-Drop Image
- Include Image in HTML:
- Drag and drop an image onto the application window.
- The image will be included in the generated HTML graphics.
Troubleshooting
- Logs: Check the log area on the right side of the application for any messages or errors.
- Netlify Deployment Issues: Ensure your Netlify credentials are correct and check the Netlify dashboard for deployment logs.
By following these steps, you can effectively use the StartGG Graphic Generator to manage and display event standings, generate HTML graphics, and deploy them to Netlify.
Start.GG Graphic Generator - netlify generator [0.2.0]
# StartGG Graphic Generator
The StartGG Graphic Generator is an application designed to simplify the creation and deployment of HTML graphics for Start.GG tournaments and leagues.
Key Features
1. Graphics Creation
- Generates comprehensive HTML graphics featuring player data from Start.GG tournaments and leagues.
- Customizable fonts and colors to enhance the visual appeal of the generated content.
- Allows the integration of images into the HTML graphics.
2. Local Saving and Netlify Deployment
- Saves generated HTML files locally for easy access and sharing.
- Automates the deployment of HTML files to Netlify for online sharing.
3. Start.GG Integration
- Fetches event and standings data directly from Start.GG using provided API keys and URLs.
- Supports data fetching for both tournaments and leagues on Start.GG.
The StartGG Graphic Generator is your go-to tool for creating, customizing, and deploying HTML graphics for your Start.GG tournament needs.
to setup netlify, follow instructions here in NetlifySetup.txt
NOTE: if you wish to setup Netlify, this must be done before the app is opened for the first time after download.