sctl

A CLI/API exposing the SCUM database in a human friendly way.

✨ Why use this?

• 👉 Human friendly — designed for humans (easy access to server resources)
• 🚀 Exposed API — integrate with your existing tool (e.g. a bot, web interface, etc.)
• 🤝 Compatibility — designed with Node.js and Bun support in mind
• 🔍 Access to hard-to-reach data — makes it simple to query and interact with parts of the database that are complex to retrieve
• 🛠️ Extra resources — includes several non-database useful features like in-game time config calculations and other gameplay-related settings

🚀 Usage guide

Tip

Please verify the current usage (and all the available commands) using:

sctl --help
sctl get --help
sctl get body-simulation --help
# ...

• Get information about the owner of a vehicle:

sctl get vehicle-owner <id>

• Retrieve parsed readable prisoner's body simulation:

sctl get body-simulation <steam id 64>

📝 Changelog

Read the commits for a comprehensive list of changes.

📜 License

Licensed under MIT License.