Commands#
Billiards registers one everyday command and a set of debug and calibration tools. All of them are typed in the game chat or the F8 console — none of them is a server console command.
Command | Who | Description |
|---|---|---|
| Creator permission | Opens the table creator: place, name, price, move and delete tables. |
| Debug | A see-through table follows where you look and the mouse wheel turns it. E prints a ready-made |
| Debug | Prints a |
| Debug | Spawns a test table 2.5 m in front of you. Playable until the next restart; never saved. |
| Debug | Removes every table from the server's memory, for every player. Creator tables come back from the database on the next restart. |
| Debug | Prints in F8 whether the table, cue and ball models are valid in your game. |
| Debug | Prints in F8 every table your game knows: its id, ball count, distance and surface height. |
| Debug | Toggles edit mode: the playable area, cushions and pockets of nearby tables are drawn, with the nearest table's values on screen. |
| Debug | Moves ( |
| Debug | Raise or lower the nearest table's cloth by 3 cm. |
| Debug | Raises or lowers the cloth — 2 cm by default — and prints a ready-to-paste |
| Debug | Grows the pockets ( |
| Debug | Adjusts the cue you see behind the cue ball while you aim, for this session only. |
| Debug | Stance tuner: where the shooter stands, how far they lean, the cue and the frozen pose. |
| Debug | Hand tuner: the front (bridge) hand and the back (grip) hand. |
| Debug | Cue tuner: how far the tip sits from the ball, its turn and its height. |
| Debug | Cue rotation tuner: pitch, yaw and roll. |
The debug tools only work while Config.Debug = true; otherwise they answer with a notice and do nothing. The calibration tools work on the table nearest to you and print their values to the F8 console — nothing is written to the config for you.
Controls#
At a table#
Key | Does |
|---|---|
E | At a free table, within 2 m: opens the Pool menu. At a finished table: starts a new game. |
E | At a table someone else opened: shows the invitation to join. |
E | On your turn: steps up to take your shot. |
E — while waiting | Host only: Break now, with whoever has joined. |
Backspace — while waiting | Host only: closes the table before the game starts. |
Aiming and shooting#
Key | Does |
|---|---|
A / D | Turn the cue around the cue ball. |
Left Shift — hold | Fine aim: turn slowly. |
Right mouse — hold | Build power. The bar fills in about a second. |
Right mouse — release | Shoot. |
Backspace | Step back without shooting. It stays your turn. |
Ball in hand#
Key | Does |
|---|---|
W A S D | Move the cue ball over the cloth. |
Left Shift — hold | Move it slowly. |
E | Place it and start aiming. |
The keys at the table come from Config.Keys, as FiveM control indices.
Placing a table#
Key | Does |
|---|---|
Mouse | Aim the table at a surface, up to 50 m away. |
Z / X — hold | Rotate. |
Mouse wheel | Raise or lower 5 cm. |
Left click | Confirm. |
Backspace | Cancel. |
/poolplace works differently: the mouse wheel turns the table 5° at a time, E prints its Config.Tables line and Backspace cancels.
Calibration tools#
/poolhands, /poolarms, /poolstick and /poolstickrot put a copy of your ped at the nearest table and share their keys. Their on-screen help is in Spanish; this is the same list in English:
Key | Does |
|---|---|
Arrow keys | Change the highlighted values: ↑↓ the first, ←→ the second. |
Left Alt — hold | Switch the arrows to the third value — height, roll and so on. |
Left Shift — hold | Fine steps. |
X | In /poolhands and /poolarms: next group of values. |
Z / X — hold | In /poolstick and /poolstickrot: slide the test ball away from or towards the ped. |
G | Print every value to F8, ready to paste into |
Backspace | Exit. The values are printed once more. |
/poolhands — stance, lean, cue and pose
Stance — ↑↓ how far behind the rail the feet stand (
standBack), ←→ how far to one side (sideOffset), Alt+↑↓ the turn of the body (headingYaw).Lean — ↑↓ the forward lean (
leanPitch), ←→ the height of the ped (pedZRaise).Cue — ↑↓ the tip towards or away from the ball (
cue.ballGap), ←→ its turn (cue.yaw), Alt+↑↓ its height (cue.rise).Pose — ←→ cycles four animations, ↑↓ moves the frozen moment of the one chosen (
anim).
/poolarms — the two hands
A green sphere marks the front (bridge) hand and an orange one the back (grip) hand. For the selected hand, ↑↓ moves it forward or back, ←→ to the side, and Alt+↑↓ up or down — ik.bridgeFwd, bridgeSide, bridgeRise and their grip equivalents.
/poolstick — where the cue sits
↑↓ moves the tip towards or away from the ball (cue.ballGap), ←→ turns it (cue.yaw), Alt+↑↓ raises it (cue.rise) and Alt+←→ sets cue.restFwd. The distance from the ped to the ball is shown at the bottom, so you can check the cue with the ball near and far.
/poolstickrot — how the cue is turned
↑↓ tilts the butt of the cue up or down (cue.pitch), ←→ swings it to the side (cue.yaw) and Alt+↑↓ rolls it (cue.roll). The tip stays on the ball while you turn it.
For Developers#
Billiards has no exports. Everything another resource — or your own server — might want to change goes through the bridge functions, which live in unencrypted files:
Function | Side | Decides |
|---|---|---|
| Server | Entry fees, bets and payouts. In |
| Server | Who can open the creator. In |
| Server | The name other players see. In |
| Client | Messages, the [E] prompt and the Pool menu. In |
Examples for each are in Integrations.