Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.17 KB

README.md

File metadata and controls

31 lines (24 loc) · 1.17 KB
Raw

cfx-server-data

The data repository for Cfx.re servers

Usage

  1. Make sure to git clone. Don't "Download ZIP", as that'll make it much harder to update to newer versions.
  2. Put custom resources in resources/[local]/ if you don't want to be affected by any random messups.

Advanced usage

You can also consider using the repository as a submodule + symlink for your own Git repository:

Linux:

$ git submodule add https://github.com/citizenfx/cfx-server-data.git vendor/server-data
$ ln -s vendor/server-data/resources/ 'resources/[base]/'

Windows:

> git submodule add https://github.com/citizenfx/cfx-server-data.git vendor/server-data
> mklink /d resources\[base] vendor\server-data\resources

Policy

You can make pull requests to propose changes that benefit everyone. Add new useful resources, change/improve existing ones - anything goes, as long as you make sure to:

  1. Not break existing users/APIs.
  2. Not change default behavior without a toggle.
  3. Use best practices (convars over config files, native commands wherever possible, etc.)

Modifying or rewriting existing resources in this repository for local use only is strongly discouraged.