SC-Tool Discord Bot

SC-Tool is a comprehensive Discord bot designed for Star Citizen communities. It offers a wide range of features to enhance your Star Citizen gaming experience, track player information, manage bounties, record cargo trading, and much more.

Table of Contents

1. Introduction
2. Installation & Setup
3. Command Categories
   • Player Information
   • Ship Information
   • Organization Management
   • Bounty Contracts
   • Cargo Trading
   • Kill Tracking
   • Bingo
   • Polls and Voting
   • Administration
4. Technical Details
5. Configuration

Introduction

SC-Tool helps Star Citizen communities with:

• Tracking player information and statistics
• Managing ship information and details
• Creating and managing bounty contracts
• Recording cargo trading operations
• Tracking PvP kills and engagements
• Running community events like polls, raffles, and bingo
• Managing organizations

The bot uses Discord's hybrid commands, supporting both slash commands.

Command Categories

Player Information

!plyr_info [player_name] [player_name2] [player_name3] [player_name4] [player_name5]

Retrieves detailed information about Star Citizen players.

• Parameters:

  • player_name: Name of the primary player to lookup
  • player_name2-5 (optional): Additional player names to lookup

• Description: Displays comprehensive information about players including:

  • Nickname and display name
  • Organization membership
  • Organization rank and role
  • Personal information (enlistment date, location, languages)
  • Arena Commander/Star Marine statistics
  • Bio
  • Lists status (if on any naughty/nice/pirated lists)

• Example:

  !plyr_info MinMin
  

!plyr_org_lists [list_type]

Lists players or organizations from specified lists.

• Parameters:

  • list_type: Either "player" or "org"

• Description: Shows players or organizations on various lists (naughty, nice, or pirated) with reasons for their inclusion.

• Example:

  !plyr_org_lists player
  

!plyr_remove [playername] [list_name]

Removes a player from a specified list.

• Parameters:

  • playername: Name of the player to remove
  • list_name: List to remove from (naughty_list, nice_list, pirated_list)

• Description: Admin-only command to remove players from tracking lists.

• Example:

  !plyr_remove MinMin naughty_list
  

Ship Information

!ship_info [ship_name]

Retrieves detailed information about Star Citizen ships.

• Parameters:

  • ship_name: Name of the ship to lookup

• Description: Displays comprehensive ship information including:

  • Manufacturer
  • Pledge price
  • Crew size
  • Cargo capacity
  • Purchase locations and prices
  • Rental availability
  • Loaner ships
  • Ship images

• Example:

  !ship_info Cutlass Black
  

Organization Management

!org_info [org_name]

Retrieves information about a Star Citizen organization.

• Parameters:

  • org_name: Name or tag of the organization to lookup

• Description: Displays organization information including:

  • Organization name and tag
  • Member count
  • Primary and secondary activities
  • Archetype and commitment level
  • Recruiting status
  • Language

• Example:

  !org_info TEST
  

!ORG_LB

Shows organization leaderboards.

• Description: Displays rankings and statistics for organizations.

!Org_ranking

Shows organization rankings.

• Description: Displays a list of organizations ranked by various metrics.

Bounty Contracts

!bounty_contract_create [params]

Creates a bounty contract for either a player or organization.

• Parameters:

  • times_claimable: Number of times contract can be claimed
  • player_name: Target player name (optional)
  • org_name: Target organization name (optional)
  • uec_worth: UEC value of contract
  • allowed_role: Role allowed to claim contract
  • reward_roles: Additional reward roles
  • emoji: Emoji representing the contract
  • description: Contract description
  • coins_per_claim: Coins awarded per claim
  • bonus_coins: Bonus coins for completing all claims

• Description: Admin command to create new bounty contracts for players or organizations.

• Example:

  !bounty_contract_create 5 MinMin 10000 @Hunter "Kill on sight" 100 50
  

!bounty_purchase [params]

Purchase a bounty contract using coins.

• Parameters:

  • times_claimable: Number of times contract can be claimed
  • allowed_role: Role allowed to claim contract
  • emoji: Emoji representing the contract
  • description: Contract description
  • player_name: Target player name (optional)
  • org_name: Target organization name (optional)
  • uec_worth: UEC value of contract

• Description: Allows users to spend coins to place bounties on players or organizations.

• Example:

  !bounty_purchase 3 @Hunter 😈 "Attacked me unprovoked" MinMin 5000
  

!bounty_claim_contract [params]

Claim a bounty contract.

• Parameters:

  • bounty_type: Type of bounty (player, org, purchased)
  • name: Short name of the contract
  • quantity: Number of claims to make

• Description: Claims a bounty contract, requiring proof and approval.

• Example:

  !bounty_claim_contract player MinMin 1
  

!bounty_contract_info [params]

View information about a specific bounty contract.

• Parameters:

  • bounty_type: Type of bounty
  • name: Short name of the contract

• Description: Shows detailed information about a bounty contract.

• Example:

  !bounty_contract_info player MinMin
  

!bounty_contract_list [bounty_type]

Lists available bounty contracts.

• Parameters:

  • bounty_type: Type of bounties to list

• Description: Displays a list of all active bounty contracts of the specified type.

• Example:

  !bounty_contract_list player
  

!bounty_contract_edit [params]

Edit an existing bounty contract.

• Parameters: Various contract parameters to update

• Description: Admin command to modify existing bounty contracts.

!bounty_contract_personal_claims [member]

View your claimed bounty contracts.

• Parameters:

  • member: Member to check (optional, defaults to self)

• Description: Shows all bounty contracts claimed by a user.

• Example:

  !bounty_contract_personal_claims
  

!bounty_contract_progress [params]

Show progress on a specific bounty contract.

• Parameters:

  • bounty_type: Type of bounty
  • contract_name: Name of the contract
  • member: Member to check (optional)

• Description: Displays progress toward completing a bounty contract.

• Example:

  !bounty_contract_progress player MinMin
  

Cargo Trading

/cargo_add [params]

Add a new cargo sale record.

• Parameters:

  • pilot: Main pilot
  • total_sale: Total sale value in UEC
  • players: Players involved
  • location: Location of the sale
  • commodity: Commodity sold
  • description: Description of the sale

• Description: Records cargo trading information for tracking profits.

• Example:

  /cargo_add @Pilot 100000 @Player1 @Player2 "Port Olisar" "Titanium"
  

/cargo_remove [pilot]

Remove an existing cargo sale record.

• Parameters:

  • pilot: The pilot and sale ID to remove

• Description: Removes a cargo sale record from the database.

• Example:

  /cargo_remove "Pilot (ID: 12345)"
  

/cargo_edit [params]

Edit an existing cargo sale record.

• Parameters: Various sale parameters to update

• Description: