https://github.com/overextended/fxserver
https://github.com/overextended/fxserver
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/overextended/fxserver
- Owner: overextended
- Created: 2026-04-30T13:16:42.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-05-01T10:29:47.000Z (about 1 month ago)
- Last Synced: 2026-05-04T01:38:01.352Z (about 1 month ago)
- Language: TypeScript
- Size: 12.7 KB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FXServer Starter Kit with Bun
A minimal template for setting up a FiveM server using `bun create`.
## Getting started
> [!NOTE]
> Install [Bun](https://bun.com) (v1.3.11 or higher) and [Git](https://git-scm.com/) if you don't already have them.
```bash
bun create overextended/fxserver
cd fxserver
```
## Configure
Most base settings can be configured in `server-data/server.cfg` (see https://aka.cfx.re/server-commands). For more configuration files, see `server-data/config`.
Your cfx license, mysql connection string, and other private variables (e.g. API keys) should be stored in `server-data/config/secrets.cfg`.
## Start FXServer
```bash
bun fx start
```
## Troubleshooting
- **FXServer artifacts won't download.**
- We've confirmed that any version of Bun prior to v1.3.11 will silently fail, due to an error with BunFile.