docs.rs failed to build screeps-api-0.5.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
screeps-api-0.6.0
rust-screeps-api
A Rust library for using the Screeps HTTP API.
Screeps is a true programming MMO where users uploading JavaScript code to power their online empires.
rust-screeps-api
can connect to the official server, and any private server instances run by
users.
rust-screeps-api
uses hyper to run http requests and serde to parse json results.
Usage
extern crate screeps_api;
use SyncApi;
let mut api = new.unwrap;
api.login.unwrap;
let my_info = api.my_info.unwrap;
println!;
Documentation is located at https://docs.rs/screeps-api/.
Unofficial API documentation for:
- HTTP endpoints at https://github.com/screepers/python-screeps/blob/master/docs/Endpoints.md.
- Websocket endpoints at https://github.com/daboross/rust-screeps-api/blob/master/protocol-docs/websocket.md
What's implemented
- Logging in
- Getting all leaderboard information
- Getting room terrain
- Checking room status
- Getting room overview info
- Getting logged in user's info
- Getting rooms where PvP recently occurred
- Websocket connections:
- Getting user CPU and Memory usage each tick
- Getting a map overview of a room
- Getting new message notifications
- Getting console messages
- Parts of getting room detailed updates
- Almost all room objects are parsed
- Flags are parsed
- RoomVisuals are not parsed
What isn't implemented
- Market API
- Messaging API
- Detailed user information API
- Game manipulation API
- Room history API
- Parsing room visuals in room socket updates.
Testing
rust-screeps-api
has both unit tests for parsing sample results from each endpoint, and integration tests which make calls to the official server.
Environmental variables used when testing:
- SCREEPS_API_USERNAME: the username to log in with for doing authenticated tests
- SCREEPS_API_PASSWORD: the password to login with for doing authenticated tests
- All variables can also be placed into a
.env
file (parsed using thedotenv
crate)
Use:
cargo test
to perform all tests, including calls to https://screeps.com with provided login details.cargo test parse
to only perform parsing unit tests. This can be performed offline.cargo test -- --skip auth
to test both parsing and all unauthenticated calls to the official server.