Quaddicted.com Forum

voidstar

Member

SoftQuake

-- Version 1.1.0 is out. You can get it here --
https://github.com/voidstar-dev/SoftQuake
https://github.com/voidstar-dev/SoftQuake/releases

Windows x86:
https://github.com/voidstar-dev/SoftQua … -win32.zip

Linux x86:
https://github.com/voidstar-dev/SoftQua … nux.tar.gz

Latest Changelog
========================
*** 1.1.0
*** 2023-09-20
========================
* Add PNG support for screenshots. Set ENABLE_PNG = 1 in `4_options.mk` or `meson.build` to enable.
* Fix file handle leak in cd_sdl.c.
* Add `host_maxfps` cvar. Defaults to 72 as in the original game. Set to lower values to emulate lower framerates.
  Values above 72 may cause physics bugs.
* Increase cd audio buffer size from 512 to 1024 bytes.
* cd audio is no longer audible if the cvar `bgmvolume` is 0 when the game is launched.
* Provide a better error message when using `sw_backend`.
  Specifying an invalid video backend with `sw_backend` will now notify the player immediately, instead of on the next restart.
  SDL2 will be used as a fallback, as before, except that now it will set the cvar to "sdl". Previously it did not.
  `sw_backend` only affects the software renderer. GLQuake remains unaffected, but can still access this variable.
* Add precompiled header to Makefile build. This speeds up the Windows build by almost 2x.
  If you're compiling the game yourself, you may want to delete the header manually after building,
  since it can take up quite a bit of disk space. In this build, the file is `quakedef.h.gch`
  Otherwise, the file is removed as part of the clean target.
* Fix `clean` target for Makefile. Now all targets are cleaned properly.
* Implement D_BeginDirectRect in the software renderer.
  This draws the loading icon in the top-right corner, just like in the DOS version.

Hi everyone.

I'd like to introduce a project I've been working on since July 2023, which I call SoftQuake.
In essence, this is cross-platform port of the original software rendered version of Quake.
The goal for this project is to bring the original visuals of the software renderer outside of DOS and WinQuake, with minimal to no changes to the engine.

First, a bit about me...
I'm just a lone C developer who enjoys writing code, and also happens to enjoy Quake.
This project was just my way of having some fun and bringing something I really wanted to see to light.
I've never any kind of online presence on any Quake forums, so this would be my first foray into this sort of thing.

I started with the original source code release, which can be found here:
https://github.com/id-Software/Quake
(Well, not the original on the web, but you know what I mean!)

Over about 1 week I whipped up a port that runs on Linux and Windows.
Here are some screenshots of the progress so far:

Start

E1M5

Arcane Dimensions Start

Yeah, I didn't exect that either, this is the unmodified engine code!
Even the breakables and projectiles work.
Note that I'm looking in the corner for a specific reason :) The engine culls more distant map geometry otherwise. I haven't figured out exactly why it does this yet. The rest of the maps (except ad_chapters) don't work, unfortunately. Also, you need to use the -mem commandline option to give Quake more memory at startup. I used -mem 32 and it was sufficient.

Video options screen

Video resolution is independent to framebuffer resolution.
Currently, framebuffer mode supports multiples of 320x200 (1x, 2x, and 3x), but can be extended to support more modes.

I have a more detailed bit of documentation here, as well as additional screenshots, for anyone interested.
However, here are a short list of features:

Game:
- Base game support
- Mod/map packs
- Audio (SFX)
- Emulated CD Audio (requires a tracklist rip)
- Keyboard/mouse support
- Multiple framebuffer resolutions (the screenshots were captured at 320x200)
- Fullscreen/borderless/windowed modes

OS:
- Windows support
- Linux support

Libraries:
- Uses SDL2 and SDL2_mixer for easy portability

Other mods tested:
- Shrak
- Copper

Releasing:
The actual game works, and this post here is my way to gague if anyone would be interested in helping me prepare this codebase for actual release.
It currently compiles on Linux using GCC, and cross compiles to a Windows exectuable with MinGW, but it is far from a user friendly install/compile process.

If anyone is just interesed in the code as-is, I could potentially also post that, but be aware that (at the moment) it's a very Linux-centric build process.

In case anyone missed it:
SoftQuake Repo (no source code yet)

PS: I have also ported GLQuake in the same manner (original codebase, no visual changes), but I'll save that one for another topic.

Special thanks to the QuakeSpasm devs. Your code was/is an invaluable resource for writing this port.

Thanks for reading!
-- SoftQuake developer

Last edited by voidstar (2023-09-21 19:33:18)

Chaser

Member

Re: SoftQuake

This sounds and looks FANTASTIC!
With Ironwail one can force big Q to look almost like the original 1996 version but this looks like something even closer to the software render. Id download and run it day 1.

Wish You all best on the project!!!

--

Guest

Re: SoftQuake

FYI: TyrQuake has a software renderer and was last updated in 2022 (can run ad_tears and everything). It's less faithful than the stated goal of SoftQuake (think Crispy vs Chocolate Doom), but could be another point of reference?

voidstar

Member

Re: SoftQuake

Thank you for the encouragement! I just spent the last day polishing up the video options screen, it's among the last additions I have left, and one of the most important. I really don't want anyone to end up with a black screen because of a mismatched setting.

Now, when using fullscreen mode, refresh rates are respected. I've only tested wth a 60 hz and 75 hz config, but both work. Borderless mode just uses whatever the current display settings are. There's some work left still, but it's getting close to complete.

I actually found out about Ironwail only a few days ago, thanks to this video by dumptruck_ds. The video is an excellent overview of the engine and the capabilities it brings. I have to say, I'm really impressed by how close the 8 bit mode is to the software render. Whoever authored the shader/conversion code for that did a bang-on job :)
Here's a comparison:

SoftQuake 8-bit (640x400 framebuffer)

Ironwail 8-bit

Also, thank you for brining up TyrQuake. I have not heard of it up until now, it looks like a pretty good port. I was able to get it up and running on my machine with no issues, but I did have to change the Makefile to use SDL instead of X11. Your observation is correct in that my goals are to provide a much more minimal port (I also made a nod towards Chocolate Doom in the readme file). Lots of talented people have already extended the engine well beyond the original design, and I'm not sure I can best that, nor is it something I'm particularly interested in recreating at the moment.

After the video settings are finished, I'll work on re-writing the Makefile system, and also see if I can get a native Windows compilation build script going. At that point the project should be ready for a "beta" release. I'll append any major update progress back into the initial post.

-- SoftQuake developer

Last edited by voidstar (2023-08-21 21:49:10)

Azarien

Guest

Re: SoftQuake

Um, kindly pointing out that I've had this little project with an identical name for quite a while now, with a similar goal (focusing on the software renderer, but it's Windows only as of now)

https://github.com/Azarien/SoftQuake

admittedly, not much has been going on there for the past few years, but I might come back to it one day…

voidstar

Member

Re: SoftQuake

Azarien, I wanted to message you on Github but to my surprise there's no messaging system there (yeah, I know I'm late to the party :))

It was never my intention to use an existing name, I just came up with it independently when I started writing this port.
Would you be okay with me continuing to use the same name as your project?

I've been working on the finishing touches this week, and the project is just about ready for its first release (nothing released yet as of this post).

If the name conflict is an issue for you, I do have a few other names I've thought of since, but it would be nice to use the existing one.

I'll hold off doing the release for the time being.

Last edited by voidstar (2023-08-25 22:53:01)

mariteaux

Member

Re: SoftQuake

I am always a fan of more software Quake! This looks phenomenal, very glad there's still people trying to keep the software renderer going on modern machines (even though I personally use Ironwail cranked up to full crunchiness these days for compatibility reasons--also colored lighting, which doesn't work in most software engines, possibly any? Didn't Qbism get colored lighting working?)

And hey, if the name conflict is an issue, can always call it Chocolate Quake. I think that sounds delicious.

Azarien

Guest

Re: SoftQuake

Okay, you can continue using that name for your project.

voidstar

Member

Re: SoftQuake

Thank you Azarien, I am very greatful!

mariteaux, thanks for your kind words! I have chosen to stick to SoftQuake, but it's a good name nontheless :)
I didn't implement colored lighting in this port either, it's about as barebones as it can be. Colored lighting in software renderers can look very nice (I'm thinking Unreal and Half-Life 1 in software mode).

For those who have been waiting for the release, thank you for your patience. The 1.0.0 release is up now:

https://github.com/voidstar-dev/SoftQuake

voidstar

Member

Re: SoftQuake

Version 1.1.0 released.