Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 1.63 KB

README.md

File metadata and controls

62 lines (48 loc) · 1.63 KB

srv: screeps room view

Build Status

A TUI application allowing viewing Screeps servers/rooms.

Screeps is a programming MMO: users control their creeps with JavaScript, and the server itself is open source

Uses the rust-screeps-api library for networking.

Current features:

  • viewing rooms
  • defaulting to a user's owned room when starting up
  • navigating around room with arrow keys or hjlk
  • switching shards by pressing 's' key
  • viewing basic information about objects under cursor

TODO:

  • implement more controls besides just "move around the room"
  • implement some display of what actions happened last tick
  • implement other viewing modes
    • profiles
    • leaderboards
    • messages
    • console

screenshot image of srv's operation

Building

Requires nightly Rust. Tested with rustc 1.36.0-nightly (372be4f36 2019-05-14).

Options:

  • Install snapshot of repository into PATH

    cargo install --git https://github.com/daboross/srv.git
    
  • Install from cloned repository

    cargo install --path .
    
  • Run directly from repository

# debug mode (faster compile, slower runtime)
cargo run -- --token 'my_auth_token'
cargo run -- --help

# release
cargo run --release -- --help
# or
cargo build --release
./target/release/srv --help