Skip to content

Latest commit

 

History

History
228 lines (167 loc) · 6.16 KB

README.md

File metadata and controls

228 lines (167 loc) · 6.16 KB
Raw

krpc-mars

This is client code for kRPC -- Kerbal Remote Procedure Call, a mod for Kerbal Space Program -- written in Rust. Mars is red because of rust on its surface, hence the name of this library.

How to use

First, create your project

$ cargo new --bin betterjeb
      Created binary (application) `betterjeb` project

You will need the .json service files bundled with the kRPC mod and the krpc-mars-terraformer library to generate rust code from them. These files are usually called KRPC.<some service>.json (there is also a file called KRPC.json, ignore it). For instance, the most important one is KRPC.SpaceCenter.json and contains the definition of the main RPCs you will want to use. Put these files in some directory within your project.

$ cd betterjeb
$ mkdir services
$ cp /path/to/KSP/game/GameData/kRPC/KRPC.*.json services/

Since these service files are likely to change often, the point of this step is to be able to use a new version of the kRPC mod without updating krpc-mars.

Let's also create the destination directory for the generated file:

$ mkdir src/services/

We now need to write a build.rs script to instruct cargo to generate the files before building our project :

// FILE: build.rs
fn main() {
    let paths: Vec<_> = glob::glob("./services/*.json")
        .unwrap()
        .filter_map(Result::ok)
        .collect();

    // Tell cargo to re-run this script only when json files in services/
    // have changed. You can choose to omit this step if you want to
    // re-generate services every time.
    for path in &paths {
        println!("cargo:rerun-if-changed={}", path.display());
    }

    // Generate Rust code and place the output in the src/services/.
    // !! ACHTUNG !! Make sure you use an empty directory or your files may be overwritten.
    krpc_mars_terraformer::run(&paths, "./src/services/").expect("Could not terraform Mars");
}

List dependencies in the Cargo.toml file :

[package]
name = "betterjeb"
version = "0.1.0"
edition = "2021"

[dependencies]
krpc-mars = { git = ... }

[build-dependencies]
glob = "0.3"
krpc-mars-terraformer = { git = ... }

The last step is to list all generated services in src/lib.rs :

We're good. Let's compile !

$ cargo build

The project structure should look something like this:

.
├── build.rs
├── Cargo.lock
├── Cargo.toml
├── services
│   ├── KRPC.Drawing.json
│   ├── KRPC.InfernalRobotics.json
│   ├── KRPC.KerbalAlarmClock.json
│   ├── KRPC.RemoteTech.json
│   ├── KRPC.SpaceCenter.json
│   └── KRPC.UI.json
└── src
    ├── main.rs
    └── services
        ├── drawing.rs
        ├── infernal_robotics.rs
        ├── kerbal_alarm_clock.rs
        ├── mod.rs
        ├── remote_tech.rs
        ├── space_center.rs
        └── ui.rs

Let's have some documentation too !

$ cargo doc --open

Examples

Simple RPC

Here is a basic example using RPCs from the SpaceCenter service:

mod services; // Generated files are here
use services::space_center;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = krpc_mars::RPCClient::connect("Example", "127.0.0.1:50000")?;

    let vessel = client.mk_call(&space_center::get_active_vessel())?;
    println!("Active vessel: {:?}", vessel);

    let crew = client.mk_call(&vessel.get_crew())?;
    println!("Crew: {:?}", crew);

    Ok(())
}

When you run this program you should see something like this:

Active vessel: Vessel(1)
Crew: [CrewMember(2)]

These numbers are ids created by the kRPC server.

Batches

You can also group RPCs in batches, meaning multiple calls will be grouped in a single packet. For instance:

let mut client = krpc_mars::RPCClient::connect("Example", "127.0.0.1:50000")?;

let (vessel, time) = krpc_mars::batch_call!(
    &mut client,
    (&space_center::get_active_vessel(), &space_center::get_ut(),)
)?;

let time = time?;
let vessel = vessel?;

println!("Current time: {}, Vessel: {:?}", time, vessel);

let (crew, _) = krpc_mars::batch_call!(
    &mut client,
    (
        &vessel.get_crew(),
        &vessel.set_type(space_center::VesselType::Probe),
    )
)?;

println!("Crew: {:?}", crew?);

If you don't want to unwrap all return values manually, then you can use the batch_call_unwrap! macro instead of batch_call!.

Using streams

Streams are easy to setup, just use to_stream() on the regular function. You will get a StreamHandle which you can use later to retrieve the result of this particular RPC from a StreamUpdate you obtained by calling recv_update() on the stream client.

let mut client = krpc_mars::RPCClient::connect("Example", "127.0.0.1:50000")?;
let mut stream_client = krpc_mars::StreamClient::connect(&client, "127.0.0.1:50001")?;

let ut_stream_handle = client.mk_call(&space_center::get_ut().to_stream())?;

loop {
    let update = stream_client.recv_update()?;

    // Streams don't update values when there's no change. The result is therefore an Option.
    if let Some(ut_result) = update.get_result(&ut_stream_handle)? {
        println!("ut: {}", ut_result);
    }
}

Of course, you can also create a stream using batches :

let mut client = krpc_mars::RPCClient::connect("Example", "127.0.0.1:50000")?;
let mut stream_client = krpc_mars::StreamClient::connect(&client, "127.0.0.1:50001")?;

let (vessel, ut_stream_handle) = krpc_mars::batch_call_unwrap!(
    &mut client,
    (
        &space_center::get_active_vessel(),
        &space_center::get_ut().to_stream(),
    )
)?;

println!("Current vessel: {:?}", vessel);

loop {
    let update = stream_client.recv_update()?;

    if let Some(ut_result) = update.get_result(&ut_stream_handle)? {
        println!("ut: {}", ut_result);
    }
}

To remove a stream, use the remove() method of the stream handle which will generate the appropriate request:

client.mk_call(&ut_stream_handle.remove())?;