
I would like to introduceCGrass, which generates 3D grass images from GitHub Contributions. You can place the generated images in your Github Profile.CGrass runs on Github actions, so all you have to do is add a workflow and rewrite the README a bit.
↓ You can see the repository of this project at the following link
How to UseCGrass
1. Create a Profile Page
Create a repository with the same name as your GitHub username.
If your GitHub username isnrysk
, create a repository namednrysk
.
2. Set Up the Workflow
Create a file named.github/workflows/cgrass.yml
.
name:Generate Picture and Push to output branchon:push:branches:-mainschedule:-cron:'00***'# Adjust the time as desiredpermissions:contents:writejobs:generate:runs-on:ubuntu-24.04steps:-name:Checkoutuses:actions/checkout@v4-name:Generate Pictureuses:nrysk/cgrass@v1.0.0with:github_username:${{ github.repository_owner }}github_token:${{ secrets.GITHUB_TOKEN }}output_path:output/output.pngcommand:"theme"argument:"github"-name:Push output image to output branchuses:crazy-max/ghaction-github-pages@v4with:target_branch:outputbuild_dir:outputcommit_message:"GenerateOutputImage"env:GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}
When you push (or Commit on GitHub), GitHub Actions will run. Once the Action completes, the generated image will be saved in the output branch.
If it encounters a segmentation fault, please rerun it.
3. Change the Theme
You can switch themes by modifying the string in the argument field.
I prepared 4 themes:github, github-nograss, planet, planet-nograss.
-name:Generate Pictureuses:nrysk/cgrass@v1.0.0with:github_username:${{ github.repository_owner }}github_token:${{ secrets.GITHUB_TOKEN }}output_path:output/output.pngcommand:"theme"argument:"github"# Change this part
github
github-nograss
planet
planet-nograss
4. Add the Image to Your Profile
To display the image in your profile’sREADME.md
, add the following line and Replace<username>
with your GitHub username.

(Optional)
You can use a custom theme by creating a theme file. For more details, please refer toCGrass.
Thank you for reading
Top comments(0)
For further actions, you may consider blocking this person and/orreporting abuse