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