https://github.com/csells/spacetraders_dart
https://github.com/csells/spacetraders_dart
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/csells/spacetraders_dart
- Owner: csells
- Created: 2023-05-08T19:29:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-09T01:38:34.000Z (about 2 years ago)
- Last Synced: 2024-12-31T20:16:33.649Z (4 months ago)
- Language: Dart
- Size: 224 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# spacetraders_dart
SpaceTraders is an open-universe game and learning platform that offers a set of
HTTP endpoints to control a fleet of ships and explore a multiplayer universe.
This is a Dart client created for SpaceTraders using [the SpaceTraders OpenAPI
definition](https://github.com/SpaceTradersAPI/api-docs/blob/main/reference/SpaceTraders.json)
and [the OpenAPI generator
tool](https://github.com/OpenAPITools/openapi-generator).
[The SpaceTraders API is documented online](https://docs.spacetraders.io/). You
can [send your first request right here in your
browser](https://api.spacetraders.io/v2) to check the status of the game server.
Unlike a traditional game, SpaceTraders does not have a first-party client or
app to play the game. Instead, you can use the API to build your own client
(which is where this project comes from), write a script to automate your ships,
or try an app built by the community.
SpaceTraders has a [Discord channel](https://discord.com/invite/jh6zurdWk5)
where you can share your projects, ask questions, and get help from other
players.
# colophon
This Dart package is automatically generated by the [OpenAPI
Generator](https://openapi-generator.tech) project:
- API version: 2.0.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen
## Requirements
Dart 2.12 or later
## Installation & Usage
### Github
If this Dart package is published to Github, add the following dependency to
your pubspec.yaml
```
dependencies:
openapi:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
### Local
To use the package in your local drive, add the following dependency to your
pubspec.yaml
```
dependencies:
openapi:
path: /path/to/openapi
```
### Usage
TODO