BattlEye GUID to Steam64 ID (and back)

A simple micro service helps setup a self-hosted REST API to translate BattlEye GUIDs into Steam 64 IDs. You build your own database.

1. Installation

You need to make sure you setup a hosting environment that can run Laravel. See requirements below.

1. Clone in your webroot git clone [email protected]:gameserverapp/guid2steam64id.git ..
2. Run composer install to install required packages.
3. Configure your .env file and confirm a working DB connection.
   1. Setup database (MariaDB)
   2. Configure queue (Beanstalk)
4. Setup Supervisor worker (see {APP ROOT}/files/supervisor_process)
5. Generate database (next step).

2. Build your database tables

Your database will start empty. This micro service comes with a generator to populate your database.

Depending on your hardware, it may take several hours to build your tables. When using queues this can be done in the background.

php artisan generate-ids

Truncate database before starting

php artisan generate-ids --truncate

Specify batch sizes

Allows you to tune the query batch size to your setup.

php artisan generate-ids --batch-size=2000

Override the total number of records generated

php artisan generate-ids --limit=10000000

Start from a specific batch

php artisan generate-ids --start-batch=1

Example output

This example was generated using QUEUE_CONNECTION=sync. When using the Beanstalk queue the output will be different.

$ php artisan generate-ids --truncate --batch-size=20000 --limit=100000
Batch [0]
Range: 0 - 20000
Generating : 0.024358034133911seconds
DB insert: 0.46555018424988 seconds
Total: 0.48990821838379 seconds

Batch [1]
Range: 20000 - 40000
Generating : 0.022361993789673seconds
DB insert: 0.36701893806458 seconds
Total: 0.38938093185425 seconds

Batch [2]
Range: 40000 - 60000
Generating : 0.022462129592896seconds
DB insert: 0.33245801925659 seconds
Total: 0.35492014884949 seconds

Batch [3]
Range: 60000 - 80000
Generating : 0.020737886428833seconds
DB insert: 0.35794305801392 seconds
Total: 0.37868094444275 seconds

Batch [4]
Range: 80000 - 100000
Generating : 0.022891998291016seconds
DB insert: 0.33835911750793 seconds
Total: 0.36125111579895 seconds

Total duration: 2.131000995636 seconds

Duration: 2 seconds
Queued batches: 5

3. Consume API

When you configured an API_KEY= in your .env file, make sure to always set a header x-api-key: {API_KEY}. The header is only required when API_KEY= is not null.

Get GUID for Steam 64 ID

GET http://localhost/steamid/76561198023513722

Response:

{"guid":"cf165a55c873587ecd183628395aeda2"}

Get Steam 64 ID for GUID

GET http://localhost/guid/cf165a55c873587ecd183628395aeda2

Response:

{"steam_id":76561198023513722}

---

Requirements

To get it running, you need to setup a LEMP / LAMP server that can run Laravel.

• PHP 7.3
• NGINX (or Apache)
• MariabDB (or MySQL)
• Composer
• Supervisor
• Beanstalkd

Machine specs

Generating all records for the database takes time. With powerful hardware you can speed this up.

Tested hardware:

• 16 vCPUs
• 32GB RAM
• SSD disk (min 200GB)

Command: php artisan generate-ids --truncate --batch-size=8000

Database population time: approx. 24 hours

---

Security Vulnerabilities

If you discover a security vulnerability within Lumen, please send an e-mail to GameServerApp at [email protected]. All security vulnerabilities will be promptly addressed.

License

This GUID2Steam64ID micro service is open-sourced software licensed under the MIT license.

---

Official Lumen & Laravel Documentation

Documentation for the framework can be found on the Lumen website.