dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions2 Packages Projects Releases Wiki Activity

cataclysmDDA: update README

Browse Source 
Add description about `useXdgDir` flag
This commit is contained in:
Mitsuhiro Nakamura 2020-07-08 11:44:11 +09:00
parent bbe7b86eea
commit fbf4b4f5ed
1 changed files with 21 additions and 10 deletions

31
pkgs/games/cataclysm-dda/README.md
View File

@ -1,14 +1,15 @@
# Cataclysm: Dark Days Ahead # Cataclysm: Dark Days Ahead
## Installation ## How to install Cataclysm DDA
To install the latest stable release of Cataclysm DDA, run To install the latest stable release of Cataclysm DDA to your profile, execute
`nix-env -f "<nixpkgs>" -iA cataclysm-dda`. `nix-env -f "<nixpkgs>" -iA cataclysm-dda`. For the curses build (build
For the curses build (build without tiles), install `cataclysmDDA.stable.curses`. without tiles), install `cataclysmDDA.stable.curses`. Note: `cataclysm-dda` is
Note: `cataclysm-dda` is an alias to `cataclysmDDA.stable.tiles`. an alias to `cataclysmDDA.stable.tiles`.
If you like access to a development build of your favorite git revision, override If you like access to a development build of your favorite git revision,
`cataclysm-dda-git` (or `cataclysmDDA.git.curses` if you like no tiles): override `cataclysm-dda-git` (or `cataclysmDDA.git.curses` if you like curses
build):
```nix ```nix
cataclysm-dda-git.override { cataclysm-dda-git.override {
@ -24,9 +25,19 @@ The sha256 checksum can be obtained by
nix-prefetch-url --unpack "https://github.com/CleverRaven/Cataclysm-DDA/archive/${YOUR_FAVORITE_REVISION}.tar.gz" nix-prefetch-url --unpack "https://github.com/CleverRaven/Cataclysm-DDA/archive/${YOUR_FAVORITE_REVISION}.tar.gz"
``` ```
The default configuration directory is `~/.cataclysm-dda`. If you prefer
`$XDG_CONFIG_HOME/cataclysm-dda`, override the derivation:
```nix
cataclysm-dda.override {
useXdgDir = true;
}
```
## Customizing with mods ## Customizing with mods
To install the game with mods of your choice, you can use `withMods` attribute: To install Cataclysm DDA with mods of your choice, you can use `withMods`
attribute:
```nix ```nix
cataclysm-dda.withMods (mods: with mods; [ cataclysm-dda.withMods (mods: with mods; [
@ -37,8 +48,8 @@ cataclysm-dda.withMods (mods: with mods; [
All mods, soundpacks, and tilesets available in nixpkgs are found in All mods, soundpacks, and tilesets available in nixpkgs are found in
`cataclysmDDA.pkgs`. `cataclysmDDA.pkgs`.
To modify existing mods and/or add more mods not available in nixpkgs, you can Here is an example to modify existing mods and/or add more mods not available
do it like this way: in nixpkgs:
```nix ```nix
let let