farmsim 0.1.0

Bindings/API schemas for all compatible Farming Simulator titles
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use serde::{
  Deserialize,
  Serialize
};

#[allow(unused)]
// Used for the doc comment without making it look ugly.
use crate::careersavegame::Statistics;

// todo; make xml-compatible with same structs below but feature flag toggle?
//       as the fields below is all from JSON payload

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Data {
  pub server:   Option<Server>,
  pub slots:    Option<Slots>,
  pub vehicles: Vec<Vehicle>,
  pub mods:     Vec<Mod>
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Server {
  #[serde(rename = "dayTime")]
  pub day_time:              i32,
  pub game:                  String,
  #[serde(rename = "mapName")]
  pub map_name:              String,
  #[serde(rename = "mapSize")]
  pub map_size:              i32,
  #[serde(rename = "mapOverviewFilename")]
  pub map_overview_filename: String,
  /// This value will always return zero in games beyond Farming Simulator 17<br>
  /// For servers post-FS17, use `money` field in [Statistics] instead
  pub money:                 i32,
  pub name:                  String,
  pub version:               String
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Slots {
  pub capacity: i8,
  pub used:     i8,
  pub players:  Vec<Player>
}

#[derive(Debug, Clone, Serialize, Deserialize)]
/// Note: The `xyz` coordinates are only visible when player is on foot!
pub struct Player {
  #[serde(rename = "isUsed")]
  pub is_used:  Option<bool>,
  #[serde(rename = "isAdmin")]
  pub is_admin: Option<bool>,
  pub uptime:   Option<i32>,
  pub x:        Option<f32>,
  pub y:        Option<f32>,
  pub z:        Option<f32>,
  pub name:     Option<String>
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Vehicle {
  pub name:     Option<String>,
  pub category: Option<String>,
  pub x:        Option<f32>,
  pub y:        Option<f32>,
  pub z:        Option<f32>,
  pub fills:    Option<Vec<VehicleFill>>
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VehicleFill {
  #[serde(rename = "type")]
  pub type_: Option<String>,
  pub level: Option<i32>
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Mod {
  pub author:      Option<String>,
  pub hash:        Option<String>,
  /// Filename, e.g "FS25_precisionFarming"
  pub name:        Option<String>,
  pub version:     Option<String>,
  /// Friendly name, e.g "Precision Farming"
  pub description: Option<String>
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Field {
  pub id:       Option<i32>,
  #[serde(rename = "isOwned")]
  pub is_owned: Option<bool>,
  pub x:        Option<f32>,
  pub z:        Option<f32>
}