Skip to content

Latest commit

ย 

History

History
195 lines (163 loc) ยท 24 KB

ENGLISH.md

File metadata and controls

195 lines (163 loc) ยท 24 KB


โญ๏ธ Please press the star! It greatly helps development! โญ๏ธ

Grow your pets through GitHub activities!

You can acquire and grow pets through GitHub activities.
When you commit 30 times, you can adopt an additional pet.
Each contribution increases a random pet's level by 1.
You can trade the pets with others.

Choose from over 50 different pets and raise them.

You can buy and manage pet in hompage


docs/sample.svg

Getting Start

You can easily apply by copying the following link to your GitHub Readme.

Important

Please replace {username} with your GitHub nickname (ex. devxb).
{username} must be your GitHub username.

Line Mode

Line mode allows you to specify one of your pets to move within the specified width and height range.
When using line mode, if you request the image in markdown, you cannot set width and height, so please use HTML format instead.

Tip

Adjust the width and height of the Img to adjust the pet's movement area.
If you make the width long and the height short (width = 1000, height = 60), the pet will move horizontally for a long distance.
Conversely, if you make the width short and the height long (width = 60, height = 1000), the pet will move vertically for a long distance.
If the pet is not visible, please make the height of the img larger than the vertical length of the pet.

<a href="https://github.com/devxb/gitanimals">
  <img src="https://render.gitanimals.org/lines/{username}" width="1000" height="120"/>
</a>

If you don't enter any value for pet-id, the first pet will be responsed.

You can check the available pet-ids in https://render.gitanimals.org/users/{username} to your GitHub username and requesting the API. Enter the value corresponding to $.personas.[].id in the API response into pet-id.

In line mode, the total number of contributions is displayed above the pet's level. If you don't want this, include contribution-view=false as a query parameter in your request.

Farm Mode

Farm mode shows all your animals and additional information.

<a href="https://github.com/devxb/gitanimals">
  <img src="https://render.gitanimals.org/farms/{username}"/>
</a>

Tips

How to Acquire Pets

Pets can be acquired in two ways:

  1. Contributions 30 times
    When you accumulate 30 commits, a new pet will appear. At this point, all pets have different probabilities of appearing.
    The maximum number of pets you can have is 30. If you have more than 30 pets, they will go into your inventory, and you can swap them with the pets displayed at any time.
  2. Purchase Pets
    You can buy pets sold by other users with commit points.
    A certain amount of points will be given per commit. Alternatively, you can sell your own pets to earn commit points.

Total Contributions

Total contributions represent the sum of contributions accumulated after joining GitHub.
New contributions may take up to 1 hour to be reflected.

Available Pets

name ratio Description
DESSERT_FOX
0.05
RABBIT
0.9
MOLE
0.3
MOLE_GRASS
0.1
QUOKKA
0.3
QUOKKA_LEAF
0.1
QUOKKA_SUNGLASSES
0.05
FISH_MAN
0.001
FISH_MAN_GLASSES
0.001
flamingo
0.08
TEN_MM
0.00 Character created by 10MM donations
Only buy in shop
10MM
goblin
0.06
goblin-bag
0.03
bibbi
0.00 Character created by BIBBI donations
Only buy in shop
BIBBI
cat
0.1
cheese-cat
0.04
galchi-cat
0.06
white-cat
0.04
goose
1.0
goose_sunglasses
0.05
goose_kotlin
0.01
goose_java
0.01
goose_js
0.01
goose_node
0.01
goose_swift
0.01
goose_linux
0.01
goose_spring
0.01
little_chick
0.9
little_chick_suglasses
0.4
little_chick_kotlin
0.01
little_chick_java
0.01
little_chick_js
0.01
little_chick_node
0.01
little_chick_swift
0.01
little_chick_linux
0.01
little_chick_spring
0.01
penguin
0.5
penguin_sunglasses
0.2
penguin_kotlin
0.01
penguin_java
0.01
penguin_js
0.01
penguin_node
0.01
penguin_swift
0.01
penguin_linux
0.01
penguin_spring
0.01
pig
0.2
pig_sunglasses
0.08
pig_kotlin
0.01
pig_java
0.01
pig_js
0.01
pig_node
0.01
pig_swift
0.01
pig_linux
0.01
pig_spring
0.01
slime_red
0.1
slime_red_kotlin
0.001
slime_red_java
0.001
slime_red_js
0.001
slime_red_node
0.001
slime_red_swift
0.001
slime_red_linux
0.001
slime_green
0.1
slime_blue
0.1
cheese_cat_collaborator
0.0 Pet made for collaborator devxb
dessert_fox_collaborator
0.0 Pet made for collaborator sumi-001
white_cat_collaborator
0.0 Pet made for collaborator Ha youna
pig_collaborator
0.0 Pet made for collaborator hyesungoh

If you have any ideas or discover a bug, please report it. Contact : [email protected]