Skip to content

darkcl/shiny

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shiny Counter CLI

Shiny counter in command line, save your progress in sqlite and text file.

asciicast

Installation

Download release file here

cd ~/Download
sudo pip install ./shiny-0.2.tar.gz --upgrade

Usage

# Go to a empty folder to save your progress

cd ~/Document/my-progress

# Start Hunting for Xerneas

shiny hunt "Xerneas"

# You can enter multiple names to hunt

shiny hunt "Poipole Pikachu"

# Add Counter for Xerneas and Poipole for 1, --add 1 is optional

shiny count "Xerneas Poipole" --add 1

# Your folder should contain Xerneas.txt, Poipole.txt and hunt.sqlite now

# Complete shiny hunt for Xerneas

shiny get "Xerneas"

# Open web server on port 8080, defalt 5000

shiny serve --port 8080

Using with OBS

  1. Insert a text layer Alt text

  2. Check 'Read from file' Alt text

  3. Select your shiny hunt target Alt text

  4. Position on your streaming setting Alt text

Server

shiny include web server function

start shiny web server with shiny serve in your progress directory

The web page contains a progress list and a simple counter.

Alt text

API

GET /api/pokemon

Usage: List all shiny progress

Return:

[
    {
        "id": "1",
        "name": "Pikachu",
        "count": "100",
        "is_finish": true,
        "finished_date": "2018-01-01"
    }
]

POST /api/pokemon

Usage: Create a tracker

Payload:

{"name": "Pikachu"}

Return:

{"id": "1"}

GET /api/pokemon/{id}

Usage: Get Current Progress from id

Return:

{
    "id": "1",
    "name": "Pikachu",
    "count": "100",
    "is_finish": true,
    "finished_date": "2018-01-01"
}

GET /api/pokemon/{id}/add

Usage: Add one to counter

Return:

{
    "id": "1",
    "name": "Pikachu",
    "count": "101",
    "is_finish": true,
    "finished_date": "2018-01-01"
}

GET /api/pokemon/{id}/completed

Usage: Complete for the hunt

Return:

{
    "id": "1",
    "name": "Pikachu",
    "count": "101",
    "is_finish": true,
    "finished_date": "2018-01-01"
}