Skip to content

Documentations

Kaito edited this page Jul 20, 2022 · 1 revision

Bot commands

List the usages of all the commands available in the bot.

Commands Function
/start -
/starmap -
/astrodata -
/weather -
/sun -
/iss -
/subscribe (or /sub) -
/unsubscribe (or /unsub) -
/myinfo -
/deletemyinfo -
/setlocation -
/cancel -
/credits -

Database Structure

{
    "Users": {
        "telegram_user_id_0": {
            "latitude": 0,
            "longitude": 0,
            "address": "Your address",
            "username": "telegram_username_0",
            "utc_offset": 0,
            "creation_timestamp": "1970-01-01 00:00:00",    // UTC time, in ISO 8601 format
            "update_timestamp": "1970-01-01 00:00:00",      
            "starmap_preferences": {    // default starmap preferences
                "showEquator": false,
                "showEcliptic": true,
                "showStarNames": false,
                "showPlanetNames": true,
                "showConsNames": true,
                "showConsLines": true,
                "showConsBoundaries": false,
                "showSpecials": false,
                "use24hClock": true,    // never touch this
                "useRedscale": false    // will be removed when passing as the request params
            },
        },
        // ...
    },
    "Subscriptions": {
        "telegram_user_id_0": {
            "telegram_chat_id_0": {     // chat_id == user_id for private chats
                "astrodata": {
                    "enabled": true, 
                    "timing": {
                        "hour": "19",   // default to UTC time if no location is set
                        "minute": "30"  // store as string for now, but should be int
                    }
                },
                "iss": {
                    "enabled": false, 
                    "timing": {
                        "hour": "-1", 
                        "minute": "-1"
                    }
                },
                "starmap": {
                    "enabled": true, 
                    "timing": {
                        "hour": "00", 
                        "minute": "05"
                    }
                },
                "sun": {
                    "enabled": false, 
                    "timing": {
                        "hour": "-1", 
                        "minute": "-1"
                    }
                },
                "weather": {
                    "enabled": false, 
                    "timing": {
                        "hour": "-1", 
                        "minute": "-1"
                    }
                },
            },
        },
        // ...
    },
}
Clone this wiki locally