Categorygithub.com/HOWZ1T/space_trader
modulepackage
0.1.3
Repository: https://github.com/howz1t/space_trader.git
Documentation: pkg.go.dev

# README

Cover Image

🚀 Space Trader API 🛠️ [WIP]

Build Status codecov Go Report Card

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

💾 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
  • Trescenzi - Added Functionality & Fixed Documentation Typo
  • njfox - Various fixes & tweaks

⚖️ 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)
  • Documentation
  • Event System
  • Events:
    • Low Fuel
    • Out Of Fuel
    • Low Cargo Space
    • Cargo Full
    • Low Credits
    • Out Of Credits
    • Loan Due

# Packages

Assert provides useful utilities for writing unit tests.
Provides a caching mechanism to reduce the amount of API calls.
Provides implementation of errors for this project.
Simple Event System.
This package provides marshal-able models for all data objects in the API.

# Functions

Creates a new SpaceTrader instance.

# Structs

SpaceTrader is a struct representing the API wrapper and provides functionality for consuming the API.