Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/coadler/fishyv3

fishyv2 but with grpc+protobuf and not bad
https://github.com/coadler/fishyv3
Last synced: 13 days ago
JSON representation
fishyv2 but with grpc+protobuf and not bad
Host: GitHub
URL: https://github.com/coadler/fishyv3
Owner: coadler
Created: 2018-06-23T05:20:41.000Z (over 6 years ago)
Default Branch: develop
Last Pushed: 2018-10-09T05:26:26.000Z (about 6 years ago)
Last Synced: 2024-12-22T04:17:41.744Z (17 days ago)
Language: Go
Homepage:
Size: 11.2 MB
Stars: 2
Watchers: 5
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # Protocol Documentation



## Table of Contents

- [fishy.proto](#fishy.proto)

    - [BaitInventory](#fishyv3.BaitInventory)

    - [BlacklistRequest](#fishyv3.BlacklistRequest)

    - [BlacklistResponse](#fishyv3.BlacklistResponse)

    - [BuyBaitRequest](#fishyv3.BuyBaitRequest)

    - [BuyBaitResponse](#fishyv3.BuyBaitResponse)

    - [BuyItemRequest](#fishyv3.BuyItemRequest)

    - [BuyItemResponse](#fishyv3.BuyItemResponse)

    - [CheckGatherBaitRequest](#fishyv3.CheckGatherBaitRequest)

    - [CheckGatherBaitResponse](#fishyv3.CheckGatherBaitResponse)

    - [CheckTimeRequest](#fishyv3.CheckTimeRequest)

    - [CheckTimeResponse](#fishyv3.CheckTimeResponse)

    - [FishInventory](#fishyv3.FishInventory)

    - [FishRequest](#fishyv3.FishRequest)

    - [FishResponse](#fishyv3.FishResponse)

    - [GetBaitInventoryRequest](#fishyv3.GetBaitInventoryRequest)

    - [GetBaitInventoryResponse](#fishyv3.GetBaitInventoryResponse)

    - [GetBaitTierRequest](#fishyv3.GetBaitTierRequest)

    - [GetBaitTierResponse](#fishyv3.GetBaitTierResponse)

    - [GetLocationRequest](#fishyv3.GetLocationRequest)

    - [GetLocationResponse](#fishyv3.GetLocationResponse)

    - [InventoryRequest](#fishyv3.InventoryRequest)

    - [InventoryResponse](#fishyv3.InventoryResponse)

    - [LeaderboardRequest](#fishyv3.LeaderboardRequest)

    - [LeaderboardResponse](#fishyv3.LeaderboardResponse)

    - [LeaderboardUser](#fishyv3.LeaderboardUser)

    - [SellFishRequest](#fishyv3.SellFishRequest)

    - [SellFishResponse](#fishyv3.SellFishResponse)

    - [SetBaitTierRequest](#fishyv3.SetBaitTierRequest)

    - [SetBaitTierResponse](#fishyv3.SetBaitTierResponse)

    - [SetLocationRequest](#fishyv3.SetLocationRequest)

    - [SetLocationResponse](#fishyv3.SetLocationResponse)

    - [StartGatherBaitRequest](#fishyv3.StartGatherBaitRequest)

    - [StartGatherBaitResponse](#fishyv3.StartGatherBaitResponse)

    - [UnblacklistRequest](#fishyv3.UnblacklistRequest)

    - [UnblacklistResponse](#fishyv3.UnblacklistResponse)

    - [UserItem](#fishyv3.UserItem)

    - [UserItems](#fishyv3.UserItems)

  

    - [BaitTier](#fishyv3.BaitTier)

    - [FishCategory](#fishyv3.FishCategory)

    - [Item](#fishyv3.Item)

    - [Location](#fishyv3.Location)

  

  

    - [Fishy](#fishyv3.Fishy)

  

- [Scalar Value Types](#scalar-value-types)



Top


## fishy.proto



### BaitInventory

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| t1 | [int32](#int32) |  |  |

| t2 | [int32](#int32) |  |  |

| t3 | [int32](#int32) |  |  |

| t4 | [int32](#int32) |  |  |

| t5 | [int32](#int32) |  |  |



### BlacklistRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |



### BlacklistResponse



### BuyBaitRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |

| tier | [BaitTier](#fishyv3.BaitTier) |  |  |

| amount | [int32](#int32) |  |  |



### BuyBaitResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| new | [int32](#int32) |  |  |



### BuyItemRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| item | [Item](#fishyv3.Item) |  |  |

| tier | [int32](#int32) |  |  |



### BuyItemResponse



### CheckGatherBaitRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |



### CheckGatherBaitResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| remaining | [int32](#int32) |  | minutes left |



### CheckTimeRequest



### CheckTimeResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| time | [string](#string) |  |  |

| morning | [bool](#bool) |  |  |

| night | [bool](#bool) |  |  |



### FishInventory

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| fish | [int32](#int32) |  |  |

| garbage | [int32](#int32) |  |  |

| legendaries | [int32](#int32) |  |  |

| worth | [int32](#int32) |  |  |



### FishRequest



### FishResponse



### GetBaitInventoryRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |



### GetBaitInventoryResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| max_bait | [int32](#int32) |  |  |

| current_count | [int32](#int32) |  |  |

| bait | [BaitInventory](#fishyv3.BaitInventory) |  |  |

| current_tier | [int32](#int32) |  |  |

| baitbox_tier | [int32](#int32) |  |  |



### GetBaitTierRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |



### GetBaitTierResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| tier | [BaitTier](#fishyv3.BaitTier) |  |  |



### GetLocationRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |



### GetLocationResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| location | [Location](#fishyv3.Location) |  |  |



### InventoryRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |



### InventoryResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| items | [UserItems](#fishyv3.UserItems) |  |  |

| fish | [FishInventory](#fishyv3.FishInventory) |  |  |

| max_fish | [int32](#int32) |  |  |

| max_bait | [int32](#int32) |  |  |

| user_tier | [int32](#int32) |  |  |



### LeaderboardRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| global | [bool](#bool) |  |  |

| page | [int32](#int32) |  |  |

| user | [string](#string) |  |  |

| guild | [string](#string) |  |  |

| guild_name | [string](#string) |  |  |



### LeaderboardResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| users | [LeaderboardUser](#fishyv3.LeaderboardUser) | repeated |  |



### LeaderboardUser

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |

| score | [int32](#int32) |  |  |



### SellFishRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |

| type | [FishCategory](#fishyv3.FishCategory) |  |  |



### SellFishResponse

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| worth | [int32](#int32) |  |  |



### SetBaitTierRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |

| tier | [BaitTier](#fishyv3.BaitTier) |  |  |



### SetBaitTierResponse



### SetLocationRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |

| location | [Location](#fishyv3.Location) |  |  |



### SetLocationResponse



### StartGatherBaitRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |



### StartGatherBaitResponse



### UnblacklistRequest

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| user | [string](#string) |  |  |



### UnblacklistResponse



### UserItem

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| current | [int32](#int32) |  |  |

| owned | [int32](#int32) | repeated |  |



### UserItems

| Field | Type | Label | Description |

| ----- | ---- | ----- | ----------- |

| bait | [UserItem](#fishyv3.UserItem) |  |  |

| rod | [UserItem](#fishyv3.UserItem) |  |  |

| hook | [UserItem](#fishyv3.UserItem) |  |  |

| vehicle | [UserItem](#fishyv3.UserItem) |  |  |

| bait_box | [UserItem](#fishyv3.UserItem) |  |  |

 



### BaitTier

| Name | Number | Description |

| ---- | ------ | ----------- |

| T1 | 0 |  |

| T2 | 1 |  |

| T3 | 2 |  |

| T4 | 3 |  |

| T5 | 4 |  |



### FishCategory

| Name | Number | Description |

| ---- | ------ | ----------- |

| FISH | 0 |  |

| LEGENDARY | 1 |  |

| GARBAGE | 2 |  |

| ALL | 3 |  |



### Item

| Name | Number | Description |

| ---- | ------ | ----------- |

| BAIT | 0 |  |

| ROD | 1 |  |

| HOOK | 2 |  |

| VEHICLE | 3 |  |

| BAITBOX | 4 |  |



### Location

| Name | Number | Description |

| ---- | ------ | ----------- |

| LAKE | 0 |  |

| RIVER | 1 |  |

| OCEAN | 2 |  |

 

 



### Fishy

| Method Name | Request Type | Response Type | Description |

| ----------- | ------------ | ------------- | ------------|

| Fishy | [FishRequest](#fishyv3.FishRequest) | [FishResponse](#fishyv3.FishRequest) |  |

| Inventory | [InventoryRequest](#fishyv3.InventoryRequest) | [InventoryResponse](#fishyv3.InventoryRequest) |  |

| GetLocation | [GetLocationRequest](#fishyv3.GetLocationRequest) | [GetLocationResponse](#fishyv3.GetLocationRequest) |  |

| SetLocation | [SetLocationRequest](#fishyv3.SetLocationRequest) | [SetLocationResponse](#fishyv3.SetLocationRequest) |  |

| BuyItem | [BuyItemRequest](#fishyv3.BuyItemRequest) | [BuyItemResponse](#fishyv3.BuyItemRequest) |  |

| Blacklist | [BlacklistRequest](#fishyv3.BlacklistRequest) | [BlacklistResponse](#fishyv3.BlacklistRequest) |  |

| Unblacklist | [UnblacklistRequest](#fishyv3.UnblacklistRequest) | [UnblacklistResponse](#fishyv3.UnblacklistRequest) |  |

| StartGatherBait | [StartGatherBaitRequest](#fishyv3.StartGatherBaitRequest) | [StartGatherBaitResponse](#fishyv3.StartGatherBaitRequest) |  |

| CheckGatherBait | [CheckGatherBaitRequest](#fishyv3.CheckGatherBaitRequest) | [CheckGatherBaitResponse](#fishyv3.CheckGatherBaitRequest) |  |

| Leaderboard | [LeaderboardRequest](#fishyv3.LeaderboardRequest) | [LeaderboardResponse](#fishyv3.LeaderboardRequest) |  |

| CheckTime | [CheckTimeRequest](#fishyv3.CheckTimeRequest) | [CheckTimeResponse](#fishyv3.CheckTimeRequest) |  |

| GetBaitInventory | [GetBaitInventoryRequest](#fishyv3.GetBaitInventoryRequest) | [GetBaitInventoryResponse](#fishyv3.GetBaitInventoryRequest) |  |

| BuyBait | [BuyBaitRequest](#fishyv3.BuyBaitRequest) | [BuyBaitResponse](#fishyv3.BuyBaitRequest) |  |

| GetBaitTier | [GetBaitTierRequest](#fishyv3.GetBaitTierRequest) | [GetBaitTierResponse](#fishyv3.GetBaitTierRequest) |  |

| SetBaitTier | [SetBaitTierRequest](#fishyv3.SetBaitTierRequest) | [SetBaitTierResponse](#fishyv3.SetBaitTierRequest) |  |

| SellFish | [SellFishRequest](#fishyv3.SellFishRequest) | [SellFishResponse](#fishyv3.SellFishRequest) |  |

 

## Scalar Value Types

| .proto Type | Notes | C++ Type | Java Type | Python Type |

| ----------- | ----- | -------- | --------- | ----------- |

|  double |  | double | double | float |

|  float |  | float | float | float |

|  int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |

|  int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |

|  uint32 | Uses variable-length encoding. | uint32 | int | int/long |

|  uint64 | Uses variable-length encoding. | uint64 | long | int/long |

|  sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |

|  sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |

|  fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |

|  fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |

|  sfixed32 | Always four bytes. | int32 | int | int |

|  sfixed64 | Always eight bytes. | int64 | long | int/long |

|  bool |  | bool | boolean | boolean |

|  string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |

|  bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |