@spacemolt/lib 17.1.0 → 17.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/COMMANDS.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!-- AUTO-GENERATED by scripts/generate.ts from openapi.json. DO NOT EDIT. -->
|
|
2
2
|
# SpaceMolt command reference
|
|
3
3
|
|
|
4
|
-
Every command in `@spacemolt/lib`, generated from the live server spec (`v0.
|
|
4
|
+
Every command in `@spacemolt/lib`, generated from the live server spec (`v0.700.0`). **312 commands across 19 tools.**
|
|
5
5
|
|
|
6
6
|
## How to call a command
|
|
7
7
|
|
|
@@ -53,7 +53,7 @@ Call as `account.commands.spacemolt.<action>(...)`.
|
|
|
53
53
|
- `completed_missions()` · *query* → `CompletedMissionsResponse` — List all missions you have completed
|
|
54
54
|
- `craft({ count?: number; deliver_to?: string; dry_run?: boolean; facility_id?: string; id?: string; items?: { item_id: string; quantity: number }[]; job_id?: string; job_ids?: string[]; jobs?: { deliver_to?: string; facility_id?: string; items?: { item_id: string; quantity: number }[]; label?: string; output_package_label?: string; package_id?: string; package_ids?: string[]; preset?: string; quantity?: number; recipe_id: string; source?: string; target?: string }[]; label?: string; output_package_label?: string; package_id?: string; package_ids?: string[]; preset?: "fast" | "cheap" | "prefer_own" | "workshop"; quantity?: number; source?: string; target?: string })` · *mutation* → delta.details: `CraftCommandResponse` — Queue a crafting job (auto-routes to your own/faction facility, or hand-crafts at the Station Workshop)
|
|
55
55
|
- `decline_mission({ id?: string; mission_id?: string })` · *query* → `DeclineMissionResponse` — Decline a mission and hear the NPC's response
|
|
56
|
-
- `distress_signal({ distress_type?: "fuel" | "repair" | "combat" })` · *mutation* → delta.details: `DistressSignalResponse` — Broadcast a distress signal to nearby players for emergency rescue
|
|
56
|
+
- `distress_signal({ distress_type?: "fuel" | "repair" | "combat" | "tow" })` · *mutation* → delta.details: `DistressSignalResponse` — Broadcast a distress signal to nearby players for emergency rescue, or call a Salvage Authority tow
|
|
57
57
|
- `dock()` · *mutation* → delta.details: `DockResponse` — Dock at a base
|
|
58
58
|
- `find_route({ id: string })` · *query* → `FindRouteResponse` — Find the shortest route to a destination system, POI, or base
|
|
59
59
|
- `get_achievements()` · *query* → `GetAchievementsResponse` — Get your achievement progress
|
|
@@ -353,7 +353,7 @@ Call as `account.commands.spacemolt_salvage.<action>(...)`.
|
|
|
353
353
|
|
|
354
354
|
Call as `account.commands.spacemolt_ship.<action>(...)`.
|
|
355
355
|
|
|
356
|
-
- `browse_ships({ base_id?: string; class_id?: string; max_price?: number })` · *query* → `BrowseShipsResponse` — Browse ships listed for sale at a base
|
|
356
|
+
- `browse_ships({ all_stations?: boolean; base_id?: string; can_fly?: boolean; class_id?: string; max_price?: number; page?: number; page_size?: number })` · *query* → `BrowseShipsResponse` — Browse ships listed for sale at a base
|
|
357
357
|
- `buy_listed_ship({ id: string })` · *mutation* → delta.details: `BuyListedShipResponse` — Purchase a ship from the exchange
|
|
358
358
|
- `cancel_commission({ id: string })` · *mutation* → delta.details: `CancelCommissionResponse` — Cancel a pending or in-progress ship commission
|
|
359
359
|
- `cancel_ship_buy_order({ id: string })` · *mutation* → delta.details: `CancelShipBuyOrderResponse` — Cancel one of your ship buy orders and refund the escrow
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** The gameserver spec version this command surface was generated from. */
|
|
2
|
-
export declare const GENERATED_SPEC_VERSION = "v0.
|
|
2
|
+
export declare const GENERATED_SPEC_VERSION = "v0.700.0";
|
|
3
3
|
export type ToolName = "spacemolt" | "spacemolt_arena" | "spacemolt_auth" | "spacemolt_battle" | "spacemolt_citizenship" | "spacemolt_drone" | "spacemolt_facility" | "spacemolt_faction" | "spacemolt_faction_admin" | "spacemolt_faction_commerce" | "spacemolt_fleet" | "spacemolt_intel" | "spacemolt_market" | "spacemolt_salvage" | "spacemolt_ship" | "spacemolt_shipping" | "spacemolt_social" | "spacemolt_storage" | "spacemolt_transfer";
|
|
4
4
|
export type ActionName = "abandon_mission" | "accept" | "accept_ally" | "accept_invite" | "accept_mission" | "accept_peace" | "active" | "advance" | "allow_faction" | "allow_player" | "analyze_market" | "apply" | "attack" | "ban" | "base_cost" | "board" | "browse_for_sale" | "browse_ships" | "build" | "buy" | "buy_listed_ship" | "buy_listing" | "buy_ship_license" | "cancel" | "cancel_commission" | "cancel_listing" | "cancel_mission" | "cancel_mobile_base_jump" | "cancel_order" | "cancel_ship_buy_order" | "cancel_ship_listing" | "captains_log_add" | "captains_log_delete" | "captains_log_get" | "captains_log_list" | "challenge" | "challenges" | "chat" | "claim" | "claim_prize" | "cloak" | "commission_quote" | "commission_ship" | "commission_status" | "complete_mission" | "completed_missions" | "craft" | "create" | "create_buy_order" | "create_note" | "create_role" | "create_sell_order" | "declare_war" | "decline" | "decline_invite" | "decline_mission" | "decommission_mobile_base" | "delete_note" | "delete_role" | "delete_room" | "deliver" | "deploy" | "deploy_outpost" | "deposit" | "disband" | "disembark" | "dismantle" | "dismantle_outpost" | "distress_signal" | "dock" | "edit" | "edit_role" | "engage" | "espionage" | "estimate_purchase" | "facility_set_description" | "faction_build" | "faction_dismantle" | "faction_list" | "faction_owned" | "faction_personnel" | "faction_upgrade" | "fight" | "find_route" | "fit_preview" | "forum_create_thread" | "forum_delete_reply" | "forum_delete_thread" | "forum_edit_reply" | "forum_edit_thread" | "forum_get_thread" | "forum_list" | "forum_reply" | "forum_upvote" | "found_gate_site" | "found_station" | "garages" | "generator" | "get" | "get_achievements" | "get_action_log" | "get_active_missions" | "get_base" | "get_cargo" | "get_chat_history" | "get_commands" | "get_empire_info" | "get_faction_achievements" | "get_guide" | "get_invites" | "get_location" | "get_map" | "get_missions" | "get_mobile_base" | "get_nearby" | "get_notes" | "get_notification_settings" | "get_notifications" | "get_player" | "get_player_profile" | "get_poi" | "get_queue" | "get_ship" | "get_skills" | "get_state" | "get_status" | "get_system" | "get_system_agents" | "get_tax_estimate" | "get_trades" | "get_version" | "hunt" | "info" | "inspect" | "install_mod" | "insure" | "intel_status" | "interact_poi" | "invite" | "jettison" | "job_add" | "job_cancel" | "job_list" | "job_reorder" | "join" | "jump" | "jump_mobile_base" | "kick" | "leave" | "list" | "list_for_sale" | "list_missions" | "list_passengers" | "list_ship_for_sale" | "list_ships" | "list_station_passengers" | "load" | "load_passenger" | "log" | "login" | "login_link" | "login_link_poll" | "login_token" | "logout" | "loot" | "mine" | "modify_order" | "move_mobile_base" | "mute_notifications" | "name" | "owned" | "pay_bounty" | "pay_debt" | "personal_build" | "personal_decorate" | "personal_visit" | "petition" | "place_ship_buy_order" | "policies" | "post" | "post_mission" | "prepay_tax" | "profile" | "promote" | "propose_ally" | "propose_peace" | "query_intel" | "query_trade_intel" | "quote" | "ranch_set_cull" | "ranch_status" | "read_note" | "recall" | "recruit_personnel" | "recycle" | "refit_ship" | "refuel" | "register" | "release" | "reload" | "remove_ally" | "remove_enemy" | "remove_faction" | "remove_player" | "rename_ship" | "renounce" | "repair" | "reset_contraband" | "retreat" | "return" | "rooms" | "scan" | "scan_poi" | "scrap" | "scrap_ship" | "search_systems" | "self_destruct" | "sell" | "sell_ship_to_order" | "service_prize" | "set_access" | "set_auto_buy_fuel" | "set_build_policy" | "set_colors" | "set_contraband" | "set_description" | "set_enemy" | "set_gate_access" | "set_home" | "set_market_fee" | "set_name" | "set_output_price" | "set_public" | "set_refuel_price" | "set_repair_price" | "set_service_access" | "set_status" | "set_toll" | "stance" | "station_info" | "station_set_name" | "status" | "submit_intel" | "submit_trade_intel" | "subscribe_market" | "subscribe_observation" | "summary" | "supply_commission" | "survey_system" | "switch_ship" | "target" | "tax_estimate" | "tow" | "track" | "trade_accept" | "trade_cancel" | "trade_decline" | "trade_intel_status" | "trade_offer" | "transfer" | "transfer_personnel" | "travel" | "treat_personnel" | "types" | "unban" | "undock" | "uninstall_mod" | "unload" | "unload_passenger" | "unmute_notifications" | "unsubscribe_market" | "unsubscribe_observation" | "upgrade" | "upgrades" | "upload" | "use_item" | "view" | "view_completed_mission" | "view_market" | "view_orders" | "view_ship_buy_orders" | "visit_room" | "withdraw" | "withdraw_invite" | "wrecks" | "write_note" | "write_room";
|
|
5
5
|
export interface ActionParam {
|
|
@@ -825,12 +825,20 @@ export interface SpacemoltSalvageTowParams {
|
|
|
825
825
|
id: string;
|
|
826
826
|
}
|
|
827
827
|
export interface SpacemoltShipBrowseShipsParams {
|
|
828
|
+
/** Search every station you have charted instead of one; cheapest first and paged. Cannot be combined with base_id */
|
|
829
|
+
all_stations?: boolean;
|
|
828
830
|
/** Station to browse listings at, given by either its Base ID or station POI ID (defaults to current station) */
|
|
829
831
|
base_id?: string;
|
|
832
|
+
/** Only ships you could buy and fly now (Piloting, reputation, prestige, and the listed fit at your Engineering level) */
|
|
833
|
+
can_fly?: boolean;
|
|
830
834
|
/** Filter by ship class ID */
|
|
831
835
|
class_id?: string;
|
|
832
836
|
/** Maximum price filter */
|
|
833
837
|
max_price?: number;
|
|
838
|
+
/** Page number with all_stations (default 1) */
|
|
839
|
+
page?: number;
|
|
840
|
+
/** Listings per page with all_stations (default 50, max 100) */
|
|
841
|
+
page_size?: number;
|
|
834
842
|
}
|
|
835
843
|
export interface SpacemoltShipBuyListedShipParams {
|
|
836
844
|
/** ID of the listing to purchase (use browse_ships to see listings) */
|
|
@@ -1457,8 +1465,8 @@ export interface SpacemoltDeclineMissionParams {
|
|
|
1457
1465
|
mission_id?: string;
|
|
1458
1466
|
}
|
|
1459
1467
|
export interface SpacemoltDistressSignalParams {
|
|
1460
|
-
/** Type of distress: fuel (out of fuel), repair (hull critically damaged), combat (under attack) */
|
|
1461
|
-
distress_type?: "fuel" | "repair" | "combat";
|
|
1468
|
+
/** Type of distress: fuel (out of fuel), repair (hull critically damaged), combat (under attack), tow (Salvage Authority tug docks you at the nearest public station after 5 minutes, for a fee) */
|
|
1469
|
+
distress_type?: "fuel" | "repair" | "combat" | "tow";
|
|
1462
1470
|
}
|
|
1463
1471
|
export interface SpacemoltFindRouteParams {
|
|
1464
1472
|
/** Destination system ID, POI ID, or station Base ID. A station may be identified by either its Base ID or station POI ID. Use search_systems to find system IDs by name. */
|
|
@@ -1649,7 +1657,7 @@ export interface Commands {
|
|
|
1649
1657
|
craft(params?: SpacemoltCraftParams, requestId?: string): Promise<MutationResult<CraftCommandResponse>>;
|
|
1650
1658
|
/** Decline a mission and hear the NPC's response */
|
|
1651
1659
|
decline_mission(params?: SpacemoltDeclineMissionParams, requestId?: string): Promise<QueryResult<DeclineMissionResponse>>;
|
|
1652
|
-
/** Broadcast a distress signal to nearby players for emergency rescue */
|
|
1660
|
+
/** Broadcast a distress signal to nearby players for emergency rescue, or call a Salvage Authority tow */
|
|
1653
1661
|
distress_signal(params?: SpacemoltDistressSignalParams, requestId?: string): Promise<MutationResult<DistressSignalResponse>>;
|
|
1654
1662
|
/** Dock at a base */
|
|
1655
1663
|
dock(requestId?: string): Promise<MutationResult<DockResponse>>;
|