README
¶
🚀 Space Trader API 🛠️ [WIP]
Space Traders is an API game where players explore the stars in order to exploit for it's riches.
More info available here.
This project provides a golang wrapper for the api.
🛠️ Work In Progress
Notice this package is in it's alpha stage and is subject to api changes.
🔧 Documentation
View Go Docs here.
💾 Models
Most of the objects have been modelled and can be accessed through the model package.
The methods in this wrapper return the relevant model.
📔 Examples
💻 Contribution
This project is open to contributions.
To contribute follow the standard go style as much as possible and try to achieve an 80% code coverage or higher, with unit tests for the code submitted / changed.
Contributors will be acknowledge in this readme.
❤️ Contributors
HOWZ1T - Project Author & Maintainer
⚖️ License
This project is licensed under GNU General Public License v3.0.
📝 TODO
- More Examples
- Quick Start
- Continuous Integration
- Unit Tests (Reach at least 80% coverage)
- Current Coverage: 77.1%
- Documentation
Documentation
¶
Overview ¶
Space Traders is an API game where players explore the stars in order to exploit for it's riches.
More info available here: https://spacetraders.io/
This project provides a golang wrapper for the api.
Index ¶
- type SpaceTrader
- func (st *SpaceTrader) Account() (models.Account, error)
- func (st *SpaceTrader) ApiStatus() (string, error)
- func (st *SpaceTrader) AvailableLoans() ([]models.Loan, error)
- func (st *SpaceTrader) AvailableShips(class string) ([]models.Ship, error)
- func (st *SpaceTrader) BuyGood(shipID string, good string, quantity int) (models.ShipOrder, error)
- func (st *SpaceTrader) BuyShip(location string, shipType string) (models.Account, error)
- func (st *SpaceTrader) CreateFlightPlan(shipID string, destination string) (models.FlightPlan, error)
- func (st *SpaceTrader) GetFlightPlan(flightPlanID string) (models.FlightPlan, error)
- func (st *SpaceTrader) PayLoan(loanID string) (models.Account, error)
- func (st *SpaceTrader) RegisterUser(username string) (string, error)
- func (st *SpaceTrader) SearchSystem(system string, type_ string) ([]models.Location, error)
- func (st *SpaceTrader) SellGood(shipID string, good string, quantity int) (models.ShipOrder, error)
- func (st *SpaceTrader) SwitchUser(token string, username string)
- func (st *SpaceTrader) TakeLoan(loanType string) (models.Account, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SpaceTrader ¶
type SpaceTrader struct {
// contains filtered or unexported fields
}
SpaceTrader is a struct representing the API wrapper and provides functionality for consuming the API.
func (*SpaceTrader) Account ¶
func (st *SpaceTrader) Account() (models.Account, error)
Retrieves the user's account info.
func (*SpaceTrader) ApiStatus ¶
func (st *SpaceTrader) ApiStatus() (string, error)
Retrieves the status of the api.
func (*SpaceTrader) AvailableLoans ¶
func (st *SpaceTrader) AvailableLoans() ([]models.Loan, error)
Retrieves the available loans.
func (*SpaceTrader) AvailableShips ¶
func (st *SpaceTrader) AvailableShips(class string) ([]models.Ship, error)
Retrieves the available ships.
Ships can be filtered by specifying class.
If the class is specified as "" (empty) then no filter is applied.
func (*SpaceTrader) BuyGood ¶
Buys the specified good at the specified quantity for the specified ship. Returns ShipOrder
func (*SpaceTrader) CreateFlightPlan ¶
func (st *SpaceTrader) CreateFlightPlan(shipID string, destination string) (models.FlightPlan, error)
Creates a flight plan for the ship to the destination. Remember to calculate your estimated fuel usage!
Returns FlightPlan
func (*SpaceTrader) GetFlightPlan ¶
func (st *SpaceTrader) GetFlightPlan(flightPlanID string) (models.FlightPlan, error)
Retrieves a FlightPlan by the given ID.
func (*SpaceTrader) PayLoan ¶
func (st *SpaceTrader) PayLoan(loanID string) (models.Account, error)
Pays the specified loan. Returns the updated Account info.
func (*SpaceTrader) RegisterUser ¶
func (st *SpaceTrader) RegisterUser(username string) (string, error)
Registers a new user and returns the new user's token.
func (*SpaceTrader) SearchSystem ¶
Searches the system for the given type. Returns an array of locations.
func (*SpaceTrader) SellGood ¶
Sells the specified good at the specified quantity for the specified ship. Returns ShipOrder
func (*SpaceTrader) SwitchUser ¶ added in v0.0.5
func (st *SpaceTrader) SwitchUser(token string, username string)
Changes this instance of SpaceTrader to be the specified user.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Assert provides useful utilities for writing unit tests.
|
Assert provides useful utilities for writing unit tests. |
|
Provides implementation of errors for this project.
|
Provides implementation of errors for this project. |
|
This package provides marshal-able models for all data objects in the API.
|
This package provides marshal-able models for all data objects in the API. |