https://github.com/HOWZ1T/space_trader

Space Trader API Golang Wrapper
https://github.com/HOWZ1T/space_trader

Last synced: 12 months ago
JSON representation

Space Trader API Golang Wrapper

• Host: GitHub
• URL: https://github.com/HOWZ1T/space_trader
• Owner: HOWZ1T
• License: gpl-3.0
• Created: 2021-03-05T00:43:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T04:26:50.000Z (over 3 years ago)
• Last Synced: 2024-08-04T10:03:00.528Z (almost 2 years ago)
• Language: Go
• Size: 1.11 MB
• Stars: 9
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Cover Image](assets/cover.png)

# 🚀 Space Trader API 🛠️ [WIP]

[![Build Status](https://www.travis-ci.com/HOWZ1T/space_trader.svg?branch=master)](https://www.travis-ci.com/HOWZ1T/space_trader)

[![codecov](https://codecov.io/gh/HOWZ1T/space_trader/branch/master/graph/badge.svg?token=4L7QO7TFDX)](https://codecov.io/gh/HOWZ1T/space_trader)

[![Go Report Card](https://goreportcard.com/badge/github.com/HOWZ1T/space_trader)](https://goreportcard.com/report/github.com/HOWZ1T/space_trader)

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.

## 🛠️ Work In Progress

Notice this package is in it's alpha stage and is subject to api changes.

## 🔧 Documentation

- [Event Reference](EVENTS.md)

- [Go Docs](https://pkg.go.dev/github.com/HOWZ1T/space_trader)

## 💾 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

- 🎓 [Quick Start](examples/QUICKSTART.md)

## 💻 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](https://github.com/HOWZ1T/) - Project Author & Maintainer

- [Trescenzi](https://github.com/trescenzi) - Added Functionality & Fixed Documentation Typo

- [njfox](https://github.com/njfox) - Various fixes & tweaks

## ⚖️ License

This project is licensed under [GNU General Public License v3.0](LICENSE).

## 📝 TODO

- [ ] More Examples

  - [x] Quick Start

- [x] Continuous Integration

- [ ] Unit Tests (Reach at least 80% coverage)

- [x] Documentation

- [x] Event System

- [ ] Events:

  - [ ] Low Fuel

  - [ ] Out Of Fuel

  - [ ] Low Cargo Space

  - [ ] Cargo Full

  - [ ] Low Credits

  - [ ] Out Of Credits

  - [ ] Loan Due