Skip to content

readme: Improve FreeBSD instructions - #941

Open
concussious wants to merge 1 commit into
Novum:masterfrom
concussious:fbsd
Open

readme: Improve FreeBSD instructions#941
concussious wants to merge 1 commit into
Novum:masterfrom
concussious:fbsd

Conversation

@concussious

Copy link
Copy Markdown

This is not ready yet. We still need to clarify how rerelase/ works?

If I copy the files from $steamquakedir/rerelease to /usr/local/share/quake, then everything seems to work great except messages that appear on the screen are placeholder vars instead of the real text, such as $MAP_SKILL_NORMAL when trying to enter the base game on normal difficulty.

If I don't do that and instead copy the directories as they appear in steam (i.e., rerelease files in the rerelease/ folder), we have no music and the steam bundled mods do not show up.

Fixes: #914

My tree that is the most working looks like this:

$ tree /usr/local/share/quake/
/usr/local/share/quake/
├── ctf
│   ├── pak0.pak
│   └── vkQuake.cfg
├── dopa
│   ├── pak0.pak
│   └── vkQuake.cfg
├── hipnotic
│   └── pak0.pak
├── id1
│   ├── config.cfg
│   ├── glquake
│   │   ├── 15to8.pal
│   │   ├── (omitted many files for some semblance brevity)
│   │   └── zombie.ms2
│   ├── maps
│   │   ├── 100m.bsp
│   │   ├── 150dm3.bsp
│   │   ├── (omitted many files for some semblance brevity)
│   │   ├── zxcdm1.bsp
│   │   └── zzzzz.bsp
│   ├── music
│   │   ├── track02.ogg
│   │   ├── track03.ogg
│   │   ├── track04.ogg
│   │   ├── track05.ogg
│   │   ├── track06.ogg
│   │   ├── track07.ogg
│   │   ├── track08.ogg
│   │   ├── track09.ogg
│   │   ├── track10.ogg
│   │   └── track11.ogg
│   ├── pak0.pak
│   └── pak1.pak
├── mg1
│   ├── pak0.pak
│   └── vkQuake.cfg
├── qw
│   ├── qwprogs.dat
│   └── skins
│       ├── 311.pcx
│       ├── 311.txt
│       ├── (omitted many files for some semblance of brevity)
│       └── wolfpak.txt
├── rerelease
│   ├── ctf
│   │   └── pak0.pak
│   ├── dopa
│   │   └── pak0.pak
│   ├── hipnotic
│   │   ├── music
│   │   │   ├── track02.ogg
│   │   │   ├── track03.ogg
│   │   │   ├── track04.ogg
│   │   │   ├── track05.ogg
│   │   │   ├── track06.ogg
│   │   │   ├── track07.ogg
│   │   │   ├── track08.ogg
│   │   │   └── track09.ogg
│   │   └── pak0.pak
│   ├── id1
│   │   ├── music
│   │   │   ├── track02.ogg
│   │   │   ├── track03.ogg
│   │   │   ├── track04.ogg
│   │   │   ├── track05.ogg
│   │   │   ├── track06.ogg
│   │   │   ├── track07.ogg
│   │   │   ├── track08.ogg
│   │   │   ├── track09.ogg
│   │   │   ├── track10.ogg
│   │   │   └── track11.ogg
│   │   └── pak0.pak
│   ├── mg1
│   │   └── pak0.pak
│   └── rogue
│       ├── music
│       │   ├── track02.ogg
│       │   ├── track03.ogg
│       │   ├── track04.ogg
│       │   ├── track05.ogg
│       │   ├── track06.ogg
│       │   ├── track07.ogg
│       │   ├── track08.ogg
│       │   └── track09.ogg
│       └── pak0.pak
├── rogue
│   └── pak0.pak
└── vkquake.pak

22 directories, 1089 files

Any mods I put in there are detected automatically and appear to work, but what about music files? Should they be duplicated both places? Is this almost entirely wrong?

This is not ready yet. How does `rerelase/` work? If I copy the files
from there to `/usr/local/share/quake`, then everything seems to work
great except messages that appear on the screen are placeholder vars
instead of the real text.

If I don't do that and instead copy the directories as they appear in
steam, and put the rerelease files in the `rerelease/` folder, we have
no music and the steam bundled mods do not show up.

Fixes: Novum#914
@concussious

Copy link
Copy Markdown
Author

If I copy the files from $steamquakedir/rerelease to /usr/local/share/quake, then everything seems to work great except messages that appear on the screen are placeholder vars instead of the real text, such as $MAP_SKILL_NORMAL when trying to enter the base game on normal difficulty.

This also applies to the mods that come with the steam remaster. This one is fixed by putting QuakeEX.kpf into /usr/local/share/quake. So I'm wondering if the rerelease folder is needed at all, or what exactly should be in it.

@concussious

Copy link
Copy Markdown
Author

Ok, if I use no rerelease/ folder and put everything relevant in there into the basedir, everything works beautifully. Here's how I have it set up, I'll figure out how to express this tersely in the docs:

$ ls /usr/local/share/quake
total 14 MB
-rwxr-xr-x   1 ziaee ziaee   13M Jun  9 18:16 QuakeEX.kpf*
drwxr-xr-x   2 ziaee ziaee   13B Jul  9 02:49 ad/
drwxr-xr-x   2 ziaee ziaee    3B Jun  9 18:16 ctf/
drwxr-xr-x   2 ziaee ziaee    3B Jun  9 18:16 dopa/
drwxr-xr-x   3 ziaee ziaee    4B Jun  9 18:16 hipnotic/
drwxr-xr-x   3 ziaee ziaee    4B Jun  9 18:16 id1/
drwxr-xr-x   2 ziaee ziaee    3B Jun  9 18:16 mg1/
drwxr-xr-x   3 ziaee ziaee    4B Jun  9 19:19 qw/
drwxr-xr-x  10 ziaee ziaee   20B Jul  8 06:08 ravenkeep/
drwxr-xr-x   3 ziaee ziaee    4B Jun  9 18:16 rogue/
-rwxr-xr-x   1 ziaee ziaee  651K Jun 26 23:50 vkquake.pak

@vsonnier

Copy link
Copy Markdown
Collaborator

There is no vkquake.pak to keep, because it is directly embedded in the executable. This is sill appearing when you compile, before being embedded, that is why it is visible.

@concussious

Copy link
Copy Markdown
Author

There is no vkquake.pak to keep, because it is directly embedded in the executable. This is sill appearing when you compile, before being embedded, that is why it is visible.

Oh wow, that's an important detail. We're including it in the FreeBSD package. I'll fix our Makefile, thanks.

@concussious

concussious commented Jul 10, 2026

Copy link
Copy Markdown
Author

I proposed removing vkquake.pak and printing the following message on installation to our maintainer:

Quake assets should be placed in the shared quake base directory:
	/usr/local/share/quake

Soundtracks will be used if found in music subdirectories:
	/usr/local/share/quake/id1/music

Assets from the 2021 remaster require 'QuakeEX.kpf' in the base directory.

Does that seem clear? Should I work that into the readme?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Readme: Explain where to put files on BSD

2 participants