mirror of
https://github.com/citizenfx/cfx-server-data.git
synced 2025-01-06 21:02:57 +08:00
readme, .gitignore update, resources/local dir
This commit is contained in:
parent
51cc79eda2
commit
4fff23e2ff
4
.gitignore
vendored
4
.gitignore
vendored
@ -1,5 +1,3 @@
|
||||
CitizenMP.Server.exe
|
||||
CitizenMP.Server.exe.config
|
||||
NLog.config
|
||||
*.cfg
|
||||
/cache/
|
||||
/resources/\[local\]/
|
||||
|
31
README.md
Normal file
31
README.md
Normal file
@ -0,0 +1,31 @@
|
||||
# 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.
|
0
resources/[local]/.gitkeep
Normal file
0
resources/[local]/.gitkeep
Normal file
Loading…
Reference in New Issue
Block a user