> For the complete documentation index, see [llms.txt](https://docs.londonstudios.net/london-studios-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.londonstudios.net/london-studios-documentation/resources/pool.md). # Pool
{% hint style="success" %} You can purchase this at [https://store.londonstudios.net](https://store.londonstudios.net/) {% endhint %} ## About Pool Pool lets your players sit down at a pool table and play a proper game of 8-ball or 9-ball. They line up the shot, set the spin, hold to charge the power and watch the balls run. The table menu lets players challenge a friend, play for money or take on a computer opponent at one of four difficulty levels. Every shot is worked out on the server, so fouls, pots and wins are decided fairly and everyone nearby sees the same game. Players earn XP, level up and appear on a leaderboard, and staff can place new tables anywhere on the map. It works on standalone servers and with ESX, QBCore, QBX and vRP. Pool tables already in the world work straight away, including the ones in vanilla interiors and in MLOs that use the standard pool table props, such as [Sports Bar and Grill](/london-studios-documentation/resources/sports-bar-and-grill.md). ## Features * **8-Ball and 9-Ball -** Both games are built in, with their own rules, and players pick one from the table menu. You can switch either one off in the config, and if only one is left the choice is skipped. * **Play Any Pool Table -** Walk up to a table in the world and press **E**. Tables are found automatically, and the clutter left on pre-placed tables (loose balls, cues and triangles) is cleared away. * **Play a Friend or the Computer -** Leave a table open for anyone to join, invite a player standing nearby, or play against an AI opponent on Easy, Medium, Hard or Pro. The AI opponent is a named character who plays at the table beside you. * **Real Pool Rules -** Called pockets on the 8, scratches, wrong-ball fouls, illegal breaks, ball in hand and a shot clock are all handled for you. See [Game rules](/london-studios-documentation/resources/pool/game-rules.md). * **Aim, Spin and Power -** Aim with the mouse, drag the cue tip around the ball for top, back and side spin, and hold **Space** to charge the shot. A first-person view and a fine-aim key help with the tricky ones. * **Wagers -** Players can play a friendly game or both put up a stake, and the winner takes the pot. Stakes are charged when the second player sits down, and money from an interrupted game is paid back. * **XP, Levels and a Leaderboard -** Winning, losing and potting balls earn XP. A leaderboard shows the top players by level, win rate and games won. * **Rematches -** When a game ends either player can ask for a rematch, with the same stake if there was one. * **Match Presentation -** A short introduction plays when both players are seated, with banners for wins, losses and rank ups. Each shot has its own cinematic camera, and a shot clock keeps games moving. * **Watch a Match -** Anyone standing near a table can watch the game, hear the shots and see the balls move. * **Overhead Table Light -** Players can switch on a lamp over the table with **L**. It only lights the table for them. * **Place Your Own Tables -** Staff can put a new table down with `/pooltable`. A table can be saved so it is still there after a restart, and tables can be limited by ACE permission, job or group. * **Sound -** Cue strikes, ball clacks and cushion hits are played in 3D from a sound bank that comes with the resource, with menu sounds on top. * **Your Notification Style -** Uses the standard GTA notification, or ESX, QBCore, QBX, vRP, okokNotify, pNotify, mythic\_notify or rtx\_notify if you use one of those. * **Ten Languages -** English, Chinese, Hindi, Spanish, French, Arabic, Bengali, Portuguese, Russian and Urdu. You can copy a language file and translate it into any other. * **Highly Configurable -** Change the rules, AI difficulty, shot clock, wager amounts, XP rewards, table models, permissions, sound and menu colour. ## Getting started 1. Download Pool from your [Cfx Portal](https://portal.cfx.re/assets/granted-assets) account and extract the folder into your server `resources` directory. 2. Add the resource to your `server.cfg`. Keep the folder named **Pool**: ```cfg ensure Pool ``` 3. If you want XP, levels and the leaderboard, make sure a database resource such as `oxmysql` starts before Pool. The stats table is created for you the first time the resource starts. Without a database the games still work, but nothing is saved. See [Stats database](/london-studios-documentation/resources/pool/permissions-and-notifications.md#stats-database). 4. If you want players to bet real money, choose your framework in `config.lua`. See [Wagers](/london-studios-documentation/resources/pool/permissions-and-notifications.md#wagers). 5. Restart the server, walk up to a pool table and press **E**. Nothing extra needs streaming. The cue animations, sounds and interface all come inside the resource. For general installation steps, see [Installing Resources](/london-studios-documentation/general/installing-resources.md). ### Pool Resource Monitor/Statistics
## Documentation * [Using the resource](/london-studios-documentation/resources/pool/using-the-resource.md) * [Game rules](/london-studios-documentation/resources/pool/game-rules.md) * [Configuring the resource](/london-studios-documentation/resources/pool/configuring-the-resource.md) * [Permissions and Notifications](/london-studios-documentation/resources/pool/permissions-and-notifications.md)